This reference mirrors the current product spec. It is intentionally compact so humans and LLMs 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
Generated from specs.json
172 API endpoints across 19 domains
The table keeps the public docs aligned to the product spec. Use the OpenAPI download when you need schema-aware tooling.
Security/Compliance
7 endpoints| Method | Path | Feature | Priority |
|---|---|---|---|
| POST | /v1/auth/connectors/{provider}/authorize | OAuth, least privilege, PKCE, re-auth | MVP |
| GET | /v1/auth/connectors/{provider}/callback | OAuth, least privilege, PKCE, re-auth | MVP |
| POST | /v1/connections/{connectionId}/refresh | OAuth, least privilege, PKCE, re-auth | MVP |
| POST | /v1/admin/keys/rotate | Token vaulting, encryption, tenant isolation | MVP |
| POST | /v1/admin/retention-policies | Retention, export, deletion, compliance ops | Phase2 |
| POST | /v1/admin/export-jobs | Retention, export, deletion, compliance ops | Phase2 |
| POST | /v1/admin/delete-jobs | Retention, export, deletion, compliance ops | Phase2 |
Common auth
5 endpoints| Method | Path | Feature | Priority |
|---|---|---|---|
| POST | /v1/connections | Authentication | Common |
| GET | /v1/connections/{connectionId} | Authentication | Common |
| DELETE | /v1/connections/{connectionId} | Authentication | Common |
| POST | /v1/api-keys | Authentication | Common |
| POST | /v1/oauth/token | Authentication | Common |
Webhooks/Realtime
11 endpoints| Method | Path | Feature | Priority |
|---|---|---|---|
| POST | /v1/webhooks | Customer webhook subscriptions | MVP |
| PATCH | /v1/webhooks/{webhookId} | Customer webhook subscriptions | MVP |
| DELETE | /v1/webhooks/{webhookId} | Customer webhook subscriptions | MVP |
| GET | /v1/webhooks/{webhookId} | Customer webhook subscriptions | MVP |
| POST | /v1/webhooks/{webhookId}/test | Customer webhook subscriptions | MVP |
| GET | /v1/events/catalog | Unified event catalog and idempotent delivery | MVP |
| GET | /v1/webhooks/deliveries/{deliveryId} | Unified event catalog and idempotent delivery | MVP |
| POST | /v1/webhooks/deliveries/{deliveryId}/replay | Unified event catalog and idempotent delivery | MVP |
| GET | /v1/webhooks/dead-letter | Retry, dead letter, lifecycle management | MVP |
| POST | /v1/webhooks/dead-letter/{deliveryId}/requeue | Retry, dead letter, lifecycle management | MVP |
| GET | /v1/provider-subscriptions | Retry, dead letter, lifecycle management | MVP |
UX minimal UI requirements
6 endpoints| Method | Path | Feature | Priority |
|---|---|---|---|
| GET | /v1/webhooks | Minimal operational surfaces | MVP |
| GET | /v1/scheduling/booking-links/{slug} | Embedded booking widget | MVP |
| POST | /v1/scheduling/bookings | Embedded booking widget | MVP |
| GET | /v1/admin/audit-logs | Minimal operational surfaces | MVP |
| GET | /v1/usage | Minimal operational surfaces | MVP |
| GET | /v1/connections | Minimal operational surfaces | MVP |
| Method | Path | Feature | Priority |
|---|---|---|---|
| GET | /v1/email/capabilities/{connectionId} | Mailbox connection and capability discovery | MVP |
| GET | /v1/email/messages | Search, folders, labels, attachments | MVP |
| POST | /v1/email/messages | Messages CRUD and threads | MVP |
| GET | /v1/email/messages/{messageId} | Messages CRUD and threads | MVP |
| PATCH | /v1/email/messages/{messageId} | Messages CRUD and threads | MVP |
| DELETE | /v1/email/messages/{messageId} | Messages CRUD and threads | MVP |
| GET | /v1/email/threads/{threadId} | Messages CRUD and threads | MVP |
| GET | /v1/email/folders | Search, folders, labels, attachments | MVP |
| GET | /v1/email/labels | Search, folders, labels, attachments | MVP |
| GET | /v1/email/messages/{messageId}/attachments/{attachmentId} | Search, folders, labels, attachments | MVP |
| POST | /v1/email/drafts | Drafts, send, replies, tracking | MVP |
| GET | /v1/email/drafts/{draftId} | Drafts, send, replies, tracking | MVP |
| PATCH | /v1/email/drafts/{draftId} | Drafts, send, replies, tracking | MVP |
| POST | /v1/email/drafts/{draftId}/send | Drafts, send, replies, tracking | MVP |
| POST | /v1/email/send | Drafts, send, replies, tracking | MVP |
| GET | /v1/email/tracking/{trackingId} | Drafts, send, replies, tracking | MVP |
| POST | /v1/email/sync/start | Incremental sync and mailbox repair | MVP |
| GET | /v1/email/sync/changes | Incremental sync and mailbox repair | MVP |
| POST | /v1/email/sync/reset | Incremental sync and mailbox repair | MVP |
| GET | /v1/email/sync/status/{connectionId} | Incremental sync and mailbox repair | MVP |
Calendar
18 endpoints| Method | Path | Feature | Priority |
|---|---|---|---|
| GET | /v1/calendars | Calendars and events CRUD | MVP |
| POST | /v1/calendars | Calendars and events CRUD | MVP |
| GET | /v1/calendars/{calendarId} | Calendars and events CRUD | MVP |
| GET | /v1/calendars/{calendarId}/events | Calendars and events CRUD | MVP |
| POST | /v1/calendars/{calendarId}/events | Calendars and events CRUD | MVP |
| GET | /v1/calendars/{calendarId}/events/{eventId} | Calendars and events CRUD | MVP |
| PATCH | /v1/calendars/{calendarId}/events/{eventId} | Calendars and events CRUD | MVP |
| DELETE | /v1/calendars/{calendarId}/events/{eventId} | Calendars and events CRUD | MVP |
| POST | /v1/calendars/freebusy/query | Availability and free/busy | MVP |
| POST | /v1/calendars/availability/query | Availability and free/busy | MVP |
| POST | /v1/calendars/{calendarId}/events/{eventId}/accept | Recurrence, RSVP, reminders, conferencing | MVP |
| POST | /v1/calendars/{calendarId}/events/{eventId}/tentative | Recurrence, RSVP, reminders, conferencing | MVP |
| POST | /v1/calendars/{calendarId}/events/{eventId}/decline | Recurrence, RSVP, reminders, conferencing | MVP |
| POST | /v1/calendars/{calendarId}/events/{eventId}/conference | Recurrence, RSVP, reminders, conferencing | MVP |
| POST | /v1/calendars/{calendarId}/sync/start | Incremental sync and watch renewal | MVP |
| GET | /v1/calendars/{calendarId}/sync/changes | Incremental sync and watch renewal | MVP |
| POST | /v1/calendars/{calendarId}/sync/renew | Incremental sync and watch renewal | MVP |
| POST | /v1/calendars/{calendarId}/sync/reset | Incremental sync and watch renewal | MVP |
Contacts
15 endpoints| Method | Path | Feature | Priority |
|---|---|---|---|
| GET | /v1/contacts | Contacts CRUD | MVP |
| POST | /v1/contacts | Contacts CRUD | MVP |
| GET | /v1/contacts/{contactId} | Contacts CRUD | MVP |
| PATCH | /v1/contacts/{contactId} | Contacts CRUD | MVP |
| DELETE | /v1/contacts/{contactId} | Contacts CRUD | MVP |
| GET | /v1/contact-books | Address books, groups, and directories | Phase2 |
| POST | /v1/contact-books | Address books, groups, and directories | Phase2 |
| PATCH | /v1/contact-books/{bookId} | Address books, groups, and directories | Phase2 |
| DELETE | /v1/contact-books/{bookId} | Address books, groups, and directories | Phase2 |
| POST | /v1/contact-groups | Address books, groups, and directories | Phase2 |
| PATCH | /v1/contact-groups/{groupId} | Address books, groups, and directories | Phase2 |
| DELETE | /v1/contact-groups/{groupId} | Address books, groups, and directories | Phase2 |
| POST | /v1/contacts/sync/start | Incremental sync and dedupe assistance | MVP |
| GET | /v1/contacts/sync/changes | Incremental sync and dedupe assistance | MVP |
| POST | /v1/contacts/merge-suggestions/query | Incremental sync and dedupe assistance | MVP |
Tasks
17 endpoints| Method | Path | Feature | Priority |
|---|---|---|---|
| GET | /v1/task-lists | Task lists and tasks CRUD | MVP |
| POST | /v1/task-lists | Task lists and tasks CRUD | MVP |
| GET | /v1/task-lists/{taskListId} | Task lists and tasks CRUD | MVP |
| PATCH | /v1/task-lists/{taskListId} | Task lists and tasks CRUD | MVP |
| DELETE | /v1/task-lists/{taskListId} | Task lists and tasks CRUD | MVP |
| GET | /v1/task-lists/{taskListId}/tasks | Task lists and tasks CRUD | MVP |
| POST | /v1/task-lists/{taskListId}/tasks | Task lists and tasks CRUD | MVP |
| GET | /v1/task-lists/{taskListId}/tasks/{taskId} | Task lists and tasks CRUD | MVP |
| PATCH | /v1/task-lists/{taskListId}/tasks/{taskId} | Task lists and tasks CRUD | MVP |
| DELETE | /v1/task-lists/{taskListId}/tasks/{taskId} | Task lists and tasks CRUD | MVP |
| POST | /v1/task-lists/{taskListId}/tasks/{taskId}/checklist-items | Subtasks, checklist items, linked resources | Phase2 |
| PATCH | /v1/task-lists/{taskListId}/tasks/{taskId}/checklist-items/{itemId} | Subtasks, checklist items, linked resources | Phase2 |
| DELETE | /v1/task-lists/{taskListId}/tasks/{taskId}/checklist-items/{itemId} | Subtasks, checklist items, linked resources | Phase2 |
| POST | /v1/task-lists/{taskListId}/tasks/{taskId}/links | Subtasks, checklist items, linked resources | Phase2 |
| POST | /v1/task-lists/{taskListId}/sync/start | Task sync and reconciliation | MVP |
| GET | /v1/task-lists/{taskListId}/sync/changes | Task sync and reconciliation | MVP |
| POST | /v1/task-lists/{taskListId}/sync/reset | Task sync and reconciliation | MVP |
Scheduling/Booking
21 endpoints| Method | Path | Feature | Priority |
|---|---|---|---|
| GET | /v1/scheduling/event-types | Event types, booking profiles, booking links | MVP |
| POST | /v1/scheduling/event-types | Event types, booking profiles, booking links | MVP |
| GET | /v1/scheduling/event-types/{eventTypeId} | Event types, booking profiles, booking links | MVP |
| PATCH | /v1/scheduling/event-types/{eventTypeId} | Event types, booking profiles, booking links | MVP |
| DELETE | /v1/scheduling/event-types/{eventTypeId} | Event types, booking profiles, booking links | MVP |
| POST | /v1/scheduling/availability/query | Availability search and slot generation | MVP |
| POST | /v1/scheduling/holds | Availability search and slot generation | MVP |
| DELETE | /v1/scheduling/holds/{holdId} | Availability search and slot generation | MVP |
| GET | /v1/scheduling/bookings/{bookingId} | Create, confirm, reschedule, cancel bookings | MVP |
| POST | /v1/scheduling/bookings/{bookingId}/confirm | Create, confirm, reschedule, cancel bookings | MVP |
| POST | /v1/scheduling/bookings/{bookingId}/reschedule | Create, confirm, reschedule, cancel bookings | MVP |
| POST | /v1/scheduling/bookings/{bookingId}/cancel | Create, confirm, reschedule, cancel bookings | MVP |
| POST | /v1/scheduling/pools | Round-robin, pooled, group, routing forms | Phase2 |
| PATCH | /v1/scheduling/pools/{poolId} | Round-robin, pooled, group, routing forms | Phase2 |
| POST | /v1/scheduling/routing-forms | Round-robin, pooled, group, routing forms | Phase2 |
| PATCH | /v1/scheduling/routing-forms/{routingFormId} | Round-robin, pooled, group, routing forms | Phase2 |
| POST | /v1/scheduling/routing-forms/{routingFormId}/responses | Round-robin, pooled, group, routing forms | Phase2 |
| POST | /v1/scheduling/group-bookings | Round-robin, pooled, group, routing forms | Phase2 |
| POST | /v1/scheduling/workflows | Scheduling workflows and reminders | Phase2 |
| PATCH | /v1/scheduling/workflows/{workflowId} | Scheduling workflows and reminders | Phase2 |
| DELETE | /v1/scheduling/workflows/{workflowId} | Scheduling workflows and reminders | Phase2 |
Developer Experience
6 endpoints| Method | Path | Feature | Priority |
|---|---|---|---|
| GET | /v1/meta/openapi | OpenAPI, examples, quickstarts | MVP |
| POST | /v1/dev/simulate/event | Sandbox, mocks, webhook inspector | MVP |
| POST | /v1/dev/fake-connection | Sandbox, mocks, webhook inspector | MVP |
| GET | /v1/meta/postman | OpenAPI, examples, quickstarts | MVP |
| GET | /v1/dev/webhook-inspector | Sandbox, mocks, webhook inspector | MVP |
| GET | /v1/meta/changelog | Changelog and migration guides | MVP |
Migration/Provider adapters
5 endpoints| Method | Path | Feature | Priority |
|---|---|---|---|
| GET | /v1/meta/providers | Provider adapter registry | MVP |
| GET | /v1/meta/providers/{provider} | Provider adapter registry | MVP |
| POST | /v1/migrations/import-jobs | Import/export helpers | Phase2 |
| GET | /v1/migrations/import-jobs/{jobId} | Import/export helpers | Phase2 |
| POST | /v1/migrations/export-jobs | Import/export helpers | Phase2 |
API
4 endpoints| Method | Path | Feature | Priority |
|---|---|---|---|
| GET | /v1/meta/capabilities | Versioned REST surface | MVP |
| GET | /v1/connections/{connectionId}/capabilities | Capability introspection and raw passthrough | MVP |
| GET | /v1/{resource}/{id}/raw | Capability introspection and raw passthrough | MVP |
| POST | /v1/provider-actions/{provider}/{action} | Capability introspection and raw passthrough | MVP |
MCP/agentic orchestration
9 endpoints| Method | Path | Feature | Priority |
|---|---|---|---|
| GET | /v1/mcp/tools | Official MCP server with resource-safe tools | MVP |
| POST | /v1/mcp/sessions | Official MCP server with resource-safe tools | MVP |
| DELETE | /v1/mcp/sessions/{sessionId} | Official MCP server with resource-safe tools | MVP |
| POST | /v1/approvals | Approvals and policy-aware actions | MVP |
| POST | /v1/approvals/{approvalId}/approve | Approvals and policy-aware actions | MVP |
| POST | /v1/approvals/{approvalId}/reject | Approvals and policy-aware actions | MVP |
| GET | /v1/mcp/runs | Durable run history and provenance | Phase2 |
| GET | /v1/mcp/runs/{runId} | Durable run history and provenance | Phase2 |
| POST | /v1/mcp/runs/{runId}/replay | Durable run history and provenance | Phase2 |
Admin/Org
11 endpoints| Method | Path | Feature | Priority |
|---|---|---|---|
| GET | /v1/orgs | Organizations, users, roles | MVP |
| POST | /v1/orgs | Organizations, users, roles | MVP |
| GET | /v1/orgs/{orgId}/users | Organizations, users, roles | MVP |
| POST | /v1/orgs/{orgId}/users | Organizations, users, roles | MVP |
| PATCH | /v1/orgs/{orgId}/users/{userId} | Organizations, users, roles | MVP |
| DELETE | /v1/orgs/{orgId}/users/{userId} | Organizations, users, roles | MVP |
| GET | /v1/orgs/{orgId}/roles | Organizations, users, roles | MVP |
| POST | /v1/orgs/{orgId}/roles | Organizations, users, roles | MVP |
| GET | /v1/orgs/{orgId}/policies | Connection policies and domain installs | Phase2 |
| PATCH | /v1/orgs/{orgId}/policies | Connection policies and domain installs | Phase2 |
| POST | /v1/orgs/{orgId}/domain-installs | Connection policies and domain installs | Phase2 |
White-labeling/Branding controls
7 endpoints| Method | Path | Feature | Priority |
|---|---|---|---|
| GET | /v1/branding | Themes, assets, localized copy | MVP |
| PATCH | /v1/branding | Themes, assets, localized copy | MVP |
| POST | /v1/custom-domains | Custom domains and sender identities | Phase2 |
| GET | /v1/custom-domains | Custom domains and sender identities | Phase2 |
| POST | /v1/sender-identities | Custom domains and sender identities | Phase2 |
| GET | /v1/sender-identities | Custom domains and sender identities | Phase2 |
| GET | /v1/embed/config/{componentId} | Embeddable components | MVP |
Monitoring/Observability
2 endpoints| Method | Path | Feature | Priority |
|---|---|---|---|
| GET | /v1/admin/metrics | Core operational metrics | MVP |
| GET | /v1/admin/traces/{traceId} | Tracing and provider correlation | MVP |
Rate limits/Throttling
2 endpoints| Method | Path | Feature | Priority |
|---|---|---|---|
| GET | /v1/usage/limits | Tenant/app quotas | MVP |
| PATCH | /v1/usage/limits | Tenant/app quotas | MVP |
Billing/Usage
3 endpoints| Method | Path | Feature | Priority |
|---|---|---|---|
| GET | /v1/billing/plans | Plans, invoices, entitlements | Phase2 |
| POST | /v1/billing/subscriptions | Plans, invoices, entitlements | Phase2 |
| GET | /v1/billing/invoices | Plans, invoices, entitlements | Phase2 |
Offline/Sync
3 endpoints| Method | Path | Feature | Priority |
|---|---|---|---|
| GET | /v1/sync/status/{connectionId} | Durable cursors and checkpoints | MVP |
| POST | /v1/sync/reset/{connectionId} | Durable cursors and checkpoints | MVP |
| POST | /v1/sync/repair/{connectionId} | Repair and reconciliation jobs | MVP |