NetaDesk API Documentation

Overview

The NetaDesk platform provides REST APIs that allow applications to interact with the system for managing invitations, events, notifications, assistants, and user profiles.

All APIs use JSON request and response formats and require authentication using access tokens.

Base API Structure

All API routes follow the structure:

/v1/{resource}

Example:

GET /v1/dashboard/home

Authentication

Most API endpoints require authentication using a bearer token.

Header format:

Authorization: Bearer ACCESS_TOKEN

Standard API Response Format

All APIs return responses in a consistent structure.

{ "success": true, "data": {}, "errors": [] }

Authentication APIs

POST /v1/auth/verify-otp

Authenticate a user using mobile number verification.

{ "mobile": "9876543210", "firebaseToken": "OTP_TOKEN" }

POST /v1/auth/refresh

Refresh an expired access token.

POST /v1/auth/logout

Logout the current session.

Dashboard API

GET /v1/dashboard/home

Returns dashboard data including events summary, statistics and recent invitations.

Invitation APIs

POST /v1/invitations

Create a new invitation or event.

GET /v1/invitations

Retrieve list of invitations.

GET /v1/invitations/{id}

Retrieve invitation details.

PUT /v1/invitations/{id}

Update invitation details.

PATCH /v1/invitations/{id}/attendance

Update attendance status.

Calendar API

GET /v1/invitations/calendar

Returns calendar data for events within a date range.

Statistics API

GET /v1/stats/overview

Returns statistics including invitation counts and trends.

Assistant Management APIs

POST /v1/users/assistants

Create assistant user.

GET /v1/users/assistants

List assistants.

PUT /v1/users/assistants/{assistantId}

Update assistant information.

DELETE /v1/users/assistants/{assistantId}

Remove assistant.

Profile APIs

GET /v1/profile

Retrieve current user profile.

PUT /v1/profile

Update user profile.

Notification APIs

GET /v1/notifications

Retrieve user notifications.

PATCH /v1/notifications/{id}/read

Mark notification as read.

DELETE /v1/notifications/{id}

Delete notification.

Reminders APIs

POST /v1/invitations/{id}/reminders

Create reminder for invitation.

GET /v1/invitations/{id}/reminders

Retrieve reminders.

DELETE /v1/reminders/{reminderId}

Delete reminder.

System Administration APIs

These APIs are used by platform administrators for managing tenants and system-level configuration.

GET /v1/system/tenants

Retrieve list of registered tenants.

POST /v1/system/tenants

Create a new tenant environment.

Support

For technical assistance or API access requests, please contact:

Company: Breakpoint Info Solution
Email: support@breakpointsoft.com