Reference

API reference

Public endpoint catalog grouped by product domain.

This reference is intentionally compact so developers can scan domains quickly.

Reference artifacts

Download the machine-readable reference when you need schema-aware clients or external tools. The page view groups endpoints by domain.

  • /docs/openapi.json
  • /docs/postman.json
  • /docs/llms-full.txt

API catalog

193 API endpoints across 20 domains

The table groups public endpoints by product domain. Use the OpenAPI download when you need schema-aware tooling.

Security and compliance

7 endpoints
MethodPathFeature
POST/v1/auth/connectors/{provider}/authorizeOAuth, least privilege, PKCE, re-auth
GET/v1/auth/connectors/{provider}/callbackOAuth, least privilege, PKCE, re-auth
POST/v1/connections/{connectionId}/refreshOAuth, least privilege, PKCE, re-auth
POST/v1/admin/keys/rotateToken vaulting, encryption, tenant isolation
POST/v1/admin/retention-policiesRetention, export, deletion, compliance ops
POST/v1/admin/export-jobsRetention, export, deletion, compliance ops
POST/v1/admin/delete-jobsRetention, export, deletion, compliance ops

Common auth

5 endpoints
MethodPathFeature
POST/v1/connectionsAuthentication
GET/v1/connections/{connectionId}Authentication
DELETE/v1/connections/{connectionId}Authentication
POST/v1/api-keysAuthentication
POST/v1/oauth/tokenAuthentication

Webhooks

11 endpoints
MethodPathFeature
POST/v1/webhooksCustomer webhook subscriptions
PATCH/v1/webhooks/{webhookId}Customer webhook subscriptions
DELETE/v1/webhooks/{webhookId}Customer webhook subscriptions
GET/v1/webhooks/{webhookId}Customer webhook subscriptions
POST/v1/webhooks/{webhookId}/testCustomer webhook subscriptions
GET/v1/events/catalogUnified event catalog and idempotent delivery
GET/v1/webhooks/deliveries/{deliveryId}Unified event catalog and idempotent delivery
POST/v1/webhooks/deliveries/{deliveryId}/replayUnified event catalog and idempotent delivery
GET/v1/webhooks/dead-letterRetry, dead letter, lifecycle management
POST/v1/webhooks/dead-letter/{deliveryId}/requeueRetry, dead letter, lifecycle management
GET/v1/provider-subscriptionsRetry, dead letter, lifecycle management

User experience

6 endpoints
MethodPathFeature
GET/v1/webhooksMinimal operational surfaces
GET/v1/scheduling/booking-links/{slug}Embedded booking widget
POST/v1/scheduling/bookingsEmbedded booking widget
GET/v1/admin/audit-logsMinimal operational surfaces
GET/v1/usageMinimal operational surfaces
GET/v1/connectionsMinimal operational surfaces

Email

33 endpoints
MethodPathFeature
GET/v1/email/capabilities/{connectionId}Mailbox connection and capability discovery
GET/v1/email/messagesSearch, folders, labels, attachments
POST/v1/email/messagesMessages CRUD and threads
GET/v1/email/messages/{messageId}Messages CRUD and threads
PATCH/v1/email/messages/{messageId}Messages CRUD and threads
DELETE/v1/email/messages/{messageId}Messages CRUD and threads
GET/v1/email/threads/{threadId}Messages CRUD and threads
GET/v1/email/foldersSearch, folders, labels, attachments
GET/v1/email/labelsSearch, folders, labels, attachments
GET/v1/email/messages/{messageId}/attachments/{attachmentId}Search, folders, labels, attachments
POST/v1/email/draftsDrafts, send, replies, tracking
GET/v1/email/drafts/{draftId}Drafts, send, replies, tracking
PATCH/v1/email/drafts/{draftId}Drafts, send, replies, tracking
POST/v1/email/drafts/{draftId}/sendDrafts, send, replies, tracking
POST/v1/email/sendDrafts, send, replies, tracking
GET/v1/email/tracking/{trackingId}Drafts, send, replies, tracking
POST/v1/email/sync/startIncremental sync and mailbox repair
GET/v1/email/sync/changesIncremental sync and mailbox repair
POST/v1/email/sync/resetIncremental sync and mailbox repair
GET/v1/email/sync/status/{connectionId}Incremental sync and mailbox repair
GET/v1/email/templatesDynamic email templates
POST/v1/email/templatesDynamic email templates
GET/v1/email/templates/{templateId}Dynamic email templates
PATCH/v1/email/templates/{templateId}Dynamic email templates
DELETE/v1/email/templates/{templateId}Dynamic email templates
POST/v1/email/templates/{templateId}/previewDynamic email templates
GET/v1/email/scheduledScheduled send
GET/v1/email/scheduled/{scheduledId}Scheduled send
DELETE/v1/email/scheduled/{scheduledId}Scheduled send
POST/v1/email/ai/summarizeAI message processing
POST/v1/email/ai/classifyAI message processing
POST/v1/email/ai/extractAI message processing
POST/v1/email/ai/cleanAI message processing

Calendar

18 endpoints
MethodPathFeature
GET/v1/calendarsCalendars and events CRUD
POST/v1/calendarsCalendars and events CRUD
GET/v1/calendars/{calendarId}Calendars and events CRUD
GET/v1/calendars/{calendarId}/eventsCalendars and events CRUD
POST/v1/calendars/{calendarId}/eventsCalendars and events CRUD
GET/v1/calendars/{calendarId}/events/{eventId}Calendars and events CRUD
PATCH/v1/calendars/{calendarId}/events/{eventId}Calendars and events CRUD
DELETE/v1/calendars/{calendarId}/events/{eventId}Calendars and events CRUD
POST/v1/calendars/freebusy/queryAvailability and free/busy
POST/v1/calendars/availability/queryAvailability and free/busy
POST/v1/calendars/{calendarId}/events/{eventId}/acceptRecurrence, RSVP, reminders, conferencing
POST/v1/calendars/{calendarId}/events/{eventId}/tentativeRecurrence, RSVP, reminders, conferencing
POST/v1/calendars/{calendarId}/events/{eventId}/declineRecurrence, RSVP, reminders, conferencing
POST/v1/calendars/{calendarId}/events/{eventId}/conferenceRecurrence, RSVP, reminders, conferencing
POST/v1/calendars/{calendarId}/sync/startIncremental sync and watch renewal
GET/v1/calendars/{calendarId}/sync/changesIncremental sync and watch renewal
POST/v1/calendars/{calendarId}/sync/renewIncremental sync and watch renewal
POST/v1/calendars/{calendarId}/sync/resetIncremental sync and watch renewal

AI Meeting Notetaker

8 endpoints
MethodPathFeature
POST/v1/recordings/botsRecorder bot lifecycle
GET/v1/recordings/{recordingBotId}/statusRecorder bot lifecycle
DELETE/v1/recordings/{recordingBotId}Recorder bot lifecycle
GET/v1/recordings/policyRecorder dispatch policy
PATCH/v1/recordings/policyRecorder dispatch policy
GET/v1/recordings/{recordingBotId}/transcriptTranscript and media retrieval
GET/v1/recordings/{recordingBotId}/mediaTranscript and media retrieval
POST/v1/recordings/webhookRecording webhook intake

Contacts

15 endpoints
MethodPathFeature
GET/v1/contactsContacts CRUD
POST/v1/contactsContacts CRUD
GET/v1/contacts/{contactId}Contacts CRUD
PATCH/v1/contacts/{contactId}Contacts CRUD
DELETE/v1/contacts/{contactId}Contacts CRUD
GET/v1/contact-booksAddress books, groups, and directories
POST/v1/contact-booksAddress books, groups, and directories
PATCH/v1/contact-books/{bookId}Address books, groups, and directories
DELETE/v1/contact-books/{bookId}Address books, groups, and directories
POST/v1/contact-groupsAddress books, groups, and directories
PATCH/v1/contact-groups/{groupId}Address books, groups, and directories
DELETE/v1/contact-groups/{groupId}Address books, groups, and directories
POST/v1/contacts/sync/startIncremental sync and dedupe assistance
GET/v1/contacts/sync/changesIncremental sync and dedupe assistance
POST/v1/contacts/merge-suggestions/queryIncremental sync and dedupe assistance

Tasks

17 endpoints
MethodPathFeature
GET/v1/task-listsTask lists and tasks CRUD
POST/v1/task-listsTask lists and tasks CRUD
GET/v1/task-lists/{taskListId}Task lists and tasks CRUD
PATCH/v1/task-lists/{taskListId}Task lists and tasks CRUD
DELETE/v1/task-lists/{taskListId}Task lists and tasks CRUD
GET/v1/task-lists/{taskListId}/tasksTask lists and tasks CRUD
POST/v1/task-lists/{taskListId}/tasksTask lists and tasks CRUD
GET/v1/task-lists/{taskListId}/tasks/{taskId}Task lists and tasks CRUD
PATCH/v1/task-lists/{taskListId}/tasks/{taskId}Task lists and tasks CRUD
DELETE/v1/task-lists/{taskListId}/tasks/{taskId}Task lists and tasks CRUD
POST/v1/task-lists/{taskListId}/tasks/{taskId}/checklist-itemsSubtasks, checklist items, linked resources
PATCH/v1/task-lists/{taskListId}/tasks/{taskId}/checklist-items/{itemId}Subtasks, checklist items, linked resources
DELETE/v1/task-lists/{taskListId}/tasks/{taskId}/checklist-items/{itemId}Subtasks, checklist items, linked resources
POST/v1/task-lists/{taskListId}/tasks/{taskId}/linksSubtasks, checklist items, linked resources
POST/v1/task-lists/{taskListId}/sync/startTask sync and reconciliation
GET/v1/task-lists/{taskListId}/sync/changesTask sync and reconciliation
POST/v1/task-lists/{taskListId}/sync/resetTask sync and reconciliation

Scheduling and booking

21 endpoints
MethodPathFeature
GET/v1/scheduling/event-typesEvent types, booking profiles, booking links
POST/v1/scheduling/event-typesEvent types, booking profiles, booking links
GET/v1/scheduling/event-types/{eventTypeId}Event types, booking profiles, booking links
PATCH/v1/scheduling/event-types/{eventTypeId}Event types, booking profiles, booking links
DELETE/v1/scheduling/event-types/{eventTypeId}Event types, booking profiles, booking links
POST/v1/scheduling/availability/queryAvailability search and slot generation
POST/v1/scheduling/holdsAvailability search and slot generation
DELETE/v1/scheduling/holds/{holdId}Availability search and slot generation
GET/v1/scheduling/bookings/{bookingId}Create, confirm, reschedule, cancel bookings
POST/v1/scheduling/bookings/{bookingId}/confirmCreate, confirm, reschedule, cancel bookings
POST/v1/scheduling/bookings/{bookingId}/rescheduleCreate, confirm, reschedule, cancel bookings
POST/v1/scheduling/bookings/{bookingId}/cancelCreate, confirm, reschedule, cancel bookings
POST/v1/scheduling/poolsRound-robin, pooled, group, routing forms
PATCH/v1/scheduling/pools/{poolId}Round-robin, pooled, group, routing forms
POST/v1/scheduling/routing-formsRound-robin, pooled, group, routing forms
PATCH/v1/scheduling/routing-forms/{routingFormId}Round-robin, pooled, group, routing forms
POST/v1/scheduling/routing-forms/{routingFormId}/responsesRound-robin, pooled, group, routing forms
POST/v1/scheduling/group-bookingsRound-robin, pooled, group, routing forms
POST/v1/scheduling/workflowsScheduling workflows and reminders
PATCH/v1/scheduling/workflows/{workflowId}Scheduling workflows and reminders
DELETE/v1/scheduling/workflows/{workflowId}Scheduling workflows and reminders

Developer Experience

6 endpoints
MethodPathFeature
GET/v1/meta/openapiOpenAPI, examples, quickstarts
POST/v1/dev/simulate/eventSandbox, mocks, webhook inspector
POST/v1/dev/fake-connectionSandbox, mocks, webhook inspector
GET/v1/meta/postmanOpenAPI, examples, quickstarts
GET/v1/dev/webhook-inspectorSandbox, mocks, webhook inspector
GET/v1/meta/changelogChangelog and migration guides

Migration tools

5 endpoints
MethodPathFeature
GET/v1/meta/providersConnector metadata
GET/v1/meta/providers/{provider}Connector metadata
POST/v1/migrations/import-jobsImport/export helpers
GET/v1/migrations/import-jobs/{jobId}Import/export helpers
POST/v1/migrations/export-jobsImport/export helpers

API

4 endpoints
MethodPathFeature
GET/v1/meta/capabilitiesVersioned REST surface
GET/v1/connections/{connectionId}/capabilitiesCapability introspection and raw passthrough
GET/v1/{resource}/{id}/rawCapability introspection and raw passthrough
POST/v1/provider-actions/{provider}/{action}Capability introspection and raw passthrough

MCP and agent tools

9 endpoints
MethodPathFeature
GET/v1/mcp/toolsOfficial MCP server with resource-safe tools
POST/v1/mcp/sessionsOfficial MCP server with resource-safe tools
DELETE/v1/mcp/sessions/{sessionId}Official MCP server with resource-safe tools
POST/v1/approvalsApprovals and policy-aware actions
POST/v1/approvals/{approvalId}/approveApprovals and policy-aware actions
POST/v1/approvals/{approvalId}/rejectApprovals and policy-aware actions
GET/v1/mcp/runsDurable run history and provenance
GET/v1/mcp/runs/{runId}Durable run history and provenance
POST/v1/mcp/runs/{runId}/replayDurable run history and provenance

Admin and organization

11 endpoints
MethodPathFeature
GET/v1/orgsOrganizations, users, roles
POST/v1/orgsOrganizations, users, roles
GET/v1/orgs/{orgId}/usersOrganizations, users, roles
POST/v1/orgs/{orgId}/usersOrganizations, users, roles
PATCH/v1/orgs/{orgId}/users/{userId}Organizations, users, roles
DELETE/v1/orgs/{orgId}/users/{userId}Organizations, users, roles
GET/v1/orgs/{orgId}/rolesOrganizations, users, roles
POST/v1/orgs/{orgId}/rolesOrganizations, users, roles
GET/v1/orgs/{orgId}/policiesConnection policies and domain installs
PATCH/v1/orgs/{orgId}/policiesConnection policies and domain installs
POST/v1/orgs/{orgId}/domain-installsConnection policies and domain installs

White-labeling and branding

7 endpoints
MethodPathFeature
GET/v1/brandingThemes, assets, localized copy
PATCH/v1/brandingThemes, assets, localized copy
POST/v1/custom-domainsCustom domains and sender identities
GET/v1/custom-domainsCustom domains and sender identities
POST/v1/sender-identitiesCustom domains and sender identities
GET/v1/sender-identitiesCustom domains and sender identities
GET/v1/embed/config/{componentId}Embeddable components

Monitoring

2 endpoints
MethodPathFeature
GET/v1/admin/metricsCore operational metrics
GET/v1/admin/traces/{traceId}Tracing and source correlation

Rate limits

2 endpoints
MethodPathFeature
GET/v1/usage/limitsTenant/app quotas
PATCH/v1/usage/limitsTenant/app quotas

Billing and usage

3 endpoints
MethodPathFeature
GET/v1/billing/plansPlans, invoices, entitlements
POST/v1/billing/subscriptionsPlans, invoices, entitlements
GET/v1/billing/invoicesPlans, invoices, entitlements

Sync and repair

3 endpoints
MethodPathFeature
GET/v1/sync/status/{connectionId}Durable cursors and checkpoints
POST/v1/sync/reset/{connectionId}Durable cursors and checkpoints
POST/v1/sync/repair/{connectionId}Repair and reconciliation jobs