Endpoint catalog

All paths below are relative to /apis/v1; for example, /forms means the full public API URL /apis/v1/forms. Unless marked Public, routes require a bearer token. No routes outside /apis/v1 are part of this API reference.

Chat and meetings

Method	Path	Operation
GET	/chat/user, /chat/users	Current chat user and chat-user directory.
GET	/chat/rooms, /chat/rooms/:id	List or retrieve chat rooms.
POST	/chat/rooms	Create a room.
PUT	/chat/rooms/:id	Update a room.
DELETE	/chat/rooms/:id	Delete a room.
GET	/chat/rooms/:id/messages	List room messages.
DELETE	/chat/rooms/:id/messages/:message_id	Delete a room message.
POST	/chat/attachments	Upload a chat attachment.
POST / DELETE	/chat/rooms/:id/members / /chat/rooms/:id/members/:member_id	Add or remove room members.
GET	/chat/user/parties/:id, /chat/user/parties/:id/messages	Retrieve a user party and its messages.
GET	/chat/rooms/:id/recordings, /meetings/recordings, /meetings/live	Room, user, and live-meeting recording information.
POST	/call/rooms	Create or find a call room.
GET / POST	/call/tokens/:room_id/mint	Mint a mobile call token.
POST	/call/:call_id/external/lock	Lock external call access.
POST	/call/:call_id/external/participants/:guest_id/remove	Remove an external participant.

External invite and guest-call routes

/call/external_invites and /chat/rooms/:chat_room_id/external_invites support invite creation. Their chat_link, approvals, approval review, and domain_request subroutes manage guest access.

The following invite-token routes are Public: GET /call/external/:invite_token/status, POST /otp, POST /claim, POST /call_session, POST /livestream_join, POST /livestream_verify/request, POST /livestream_verify, GET|POST /chat/messages, POST /chat/attachments, POST /session/mint, and POST /session/leave.

Contacts

Methods	Path	Operation
GET, POST	/contact/addressbooks	List or create address books.
GET, PUT, DELETE	/contact/addressbooks/:id	Read, update, or delete an address book.
POST	/contact/addressbooks/:id/move_contacts	Move contacts from an address book.
GET, POST	/contact/addressbooks/:addressbook_id/contacts	List or create contacts.
GET	/contact/addressbooks/:addressbook_id/global	List the tenant global address book.
GET, POST	/contact/addressbooks/:addressbook_id/contacts/sync	Read or apply contact sync changes.
GET, PUT, DELETE	/contact/addressbooks/:addressbook_id/contacts/:external_id	Read, update, or delete a contact.
POST	/contact/addressbooks/:addressbook_id/contacts/:external_id/move	Move a contact.
GET, PUT	/contact/self	Read or update the caller’s self contact.
GET	/contact/self/card, /contact/phone-sync/export	Download self-card or phone-sync export data.
POST	/contact/phone-sync/import	Import phone contacts.
GET	/contact/extract, /contact/directory, /contact/useraddressbooks	Extracted emails, tenant directory, and user address books.

Forms

Methods	Path	Operation
GET, POST	/forms	List or create forms.
GET	/forms/presets	List form-builder presets.
POST	/forms/draft	Create a preset or assisted draft.
GET, PATCH, PUT, DELETE	/forms/:id	Read, update, or delete a form.
POST	/forms/:id/publish, /archive, /unarchive, /accepting, /submit	Publish, archive/restore, control acceptance, or submit a response.
POST	/forms/:id/attachments, /share, /share/regenerate	Upload an answer file or manage a form share link.
DELETE	/forms/:id/share	Revoke a form share link.
GET	/forms/:id/responses, /forms/:id/responses/:response_id	List responses or retrieve a response.
GET	/forms/:id/analytics	Retrieve form analytics.
GET	/forms/:id/export.csv, /forms/:id/export.xlsx	Export responses.
GET, POST	/forms/:id/reports	List or create a saved report.
GET, PUT, DELETE	/forms/:id/reports/:report_id	Read, update, or delete a saved report.
POST, GET	/forms/:id/reports/:report_id/share	Set or list report viewers.
GET	/forms/:id/report_snapshot	Read the report-builder data snapshot.
POST	/forms/:id/report.xlsx	Export a report workbook.
GET	/reports/shared, /reports/shared/:report_id, /reports/shared/:report_id/responses, /reports/shared/:report_id/form	Read reports shared with the caller.

Calendar

Methods	Path	Operation
GET, POST	/calendar	List or create calendars.
PUT, DELETE	/calendar/:calendar_id	Update or delete a calendar.
GET	/calendar/:calendar_id/events, /instances	List events or expanded instances.
POST	/calendar/:calendar_id/events, /events/batch	Create one or batch-create events.
GET, PUT, DELETE	/calendar/:calendar_id/events/:event_id	Read, update, or delete an event.
PUT	/calendar/:calendar_id/events/:event_id/rsvp	Set attendance response.
POST	/calendar/:calendar_id/events/:event_id/proposals	Propose another time.
POST	/calendar/:calendar_id/sync	Synchronise a calendar.
POST	/calendar/:calendar_id/scheduling/outbox, /inbox	Send or ingest iTIP scheduling messages.
GET	/calendar/:calendar_id/scheduling/messages, /messages/:message_id	List or read scheduling messages.
POST	/calendar/scheduling/free_busy, /calendar/polls	Query free/busy or create a time poll.
GET	/calendar/polls/:id, /calendar/title-suggestions, /calendar/related, /calendar/holidays, /calendar/holidays/effective	Poll, suggestions, related items, and holiday data.
POST	/calendar/polls/:id/vote, /finalize	Vote on or finalise a time poll.
GET, PUT	/calendar/holiday-subscriptions	Read or update personal holiday subscriptions.
PUT	/calendar/holiday-subscriptions/tenant	Update tenant holiday subscriptions.

Tasks, notes, and folders

Methods	Path	Operation
GET, POST	/tasks	List or create tasks.
GET, PATCH, PUT, DELETE	/tasks/:id	Read, update, or delete a task.
POST	/tasks/:task_id/subtasks, /attachments, /comments	Add a subtask, attachment, or comment.
PUT, DELETE	/tasks/:task_id/subtasks/:id	Update or delete a subtask.
DELETE	/tasks/:task_id/attachments/:id	Delete an attachment.
GET	/tasks/:id/panel, /search/tasks	Retrieve a task panel or search tasks.
GET, POST	/notes	List or create notes.
GET, PATCH, PUT, DELETE	/notes/:id	Read, update, or soft-delete a note.
GET	/notes/changes, /notes/index, /notes/:id/export.docx, /notes/:id/revisions, /notes/:id/revisions/:revision, /search/notes	Note sync, export, history, and search.
POST	/notes/:id/task, /share, /share/regenerate, /restore	Create linked task, manage sharing, or restore a note.
PUT	/notes/:id/invited	Set note invitees.
DELETE	/notes/:id/share, /purge	Revoke sharing or permanently delete a note.
GET, POST	/note_folders, /task_folders	List or create folders.
GET, PATCH, PUT, DELETE	/note_folders/:id	Read, update, or delete note folders.
PATCH, PUT, DELETE	/task_folders/:id	Update or delete task folders.
GET	/note_folders/changes, /note_folders/index	Note-folder sync and resync.

Tenant, access, notifications, and mail

Methods	Path	Operation
GET	/tenant, /tenant/logo	Read tenant identity, verified domains, or branding.
GET, POST	/rbac/groups	List or create RBAC groups.
PUT, DELETE	/rbac/groups/:group_id	Update or delete a group.
GET, POST, DELETE	/rbac/groups/:group_id/members, /members/:user_id	List, add, or remove members.
GET, POST, DELETE	/rbac/groups/:group_id/permissions, /permissions/:permission_id	List, grant, or revoke permissions.
GET	/notifications, /presence, /presence/:user_id, /presence/rooms/:room_id	Notifications and presence snapshots.
PUT	/notifications/read_all, /notifications/:id/read, /notifications/:id/lifecycle	Mark notification state.
PATCH	/notifications/:id/lifecycle	Update notification lifecycle.
POST	/auth/socket/token	Mint a socket token.
POST	/mail/draft, /mail/draft/submit	Save or submit a mail draft.
GET	/mail/attachment	Download a mail attachment.
See Mail API	/mail/users/me/mailboxes…	Allowlisted, user-scoped mailbox and message operations only.
GET, PUT, DELETE	/settings/profile	Read, update, or deactivate the authenticated profile.
GET, POST	/settings/signatures	List or create mail signatures.
GET, PUT, DELETE	/settings/signatures/:id	Read, update, or delete a signature.
PUT	/settings/signatures/:id/default	Set the default signature.
GET, PUT	/settings/general-preferences, /settings/notifications	Read or update user preferences.
GET	/settings/security	Read account-security state.
PUT	/settings/password	Change the signed-in user's password.
GET, POST, DELETE	/settings/application-passwords, /settings/application-passwords/:asp_id	Manage app-specific mail-client credentials.
POST	/auth/initiate-2fa, /auth/enable-2fa, /auth/verify-2fa, /auth/disable-2fa	Manage TOTP two-factor authentication.
GET	/search/calendar, /search/forms, /directory/search	Calendar/form search and directory lookup.

Uploads and concurrency

Task attachment upload uses multipart form data and has a 20 MB parser cap. Notes use optimistic concurrency: include the revision you read as base_revision or an If-Match header; stale writes return 409 with the server’s current copy.