Esta referencia refleja la especificación actual del producto. Está diseñada para que humanos y LLMs escaneen dominios con rapidez.
Artefactos de referencia
Descarga la referencia legible por máquinas cuando necesites clientes con esquema o herramientas externas. La vista de página agrupa endpoints por dominio.
- /docs/openapi.json
- /docs/postman.json
- /es/docs/llms-full.txt
Catálogo de API
193 endpoints de API en 20 dominios
La tabla agrupa endpoints públicos por dominio de producto. Usa la descarga OpenAPI cuando necesites herramientas con esquema.
Security and compliance
7 endpoints| Método | Ruta | Función |
|---|---|---|
| POST | /v1/auth/connectors/{provider}/authorize | OAuth, least privilege, PKCE, re-auth |
| GET | /v1/auth/connectors/{provider}/callback | OAuth, least privilege, PKCE, re-auth |
| POST | /v1/connections/{connectionId}/refresh | OAuth, least privilege, PKCE, re-auth |
| POST | /v1/admin/keys/rotate | Token vaulting, encryption, tenant isolation |
| POST | /v1/admin/retention-policies | Retention, export, deletion, compliance ops |
| POST | /v1/admin/export-jobs | Retention, export, deletion, compliance ops |
| POST | /v1/admin/delete-jobs | Retention, export, deletion, compliance ops |
Common auth
5 endpoints| Método | Ruta | Función |
|---|---|---|
| POST | /v1/connections | Authentication |
| GET | /v1/connections/{connectionId} | Authentication |
| DELETE | /v1/connections/{connectionId} | Authentication |
| POST | /v1/api-keys | Authentication |
| POST | /v1/oauth/token | Authentication |
Webhooks
11 endpoints| Método | Ruta | Función |
|---|---|---|
| POST | /v1/webhooks | Customer 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}/test | Customer webhook subscriptions |
| GET | /v1/events/catalog | Unified event catalog and idempotent delivery |
| GET | /v1/webhooks/deliveries/{deliveryId} | Unified event catalog and idempotent delivery |
| POST | /v1/webhooks/deliveries/{deliveryId}/replay | Unified event catalog and idempotent delivery |
| GET | /v1/webhooks/dead-letter | Retry, dead letter, lifecycle management |
| POST | /v1/webhooks/dead-letter/{deliveryId}/requeue | Retry, dead letter, lifecycle management |
| GET | /v1/provider-subscriptions | Retry, dead letter, lifecycle management |
User experience
6 endpoints| Método | Ruta | Función |
|---|---|---|
| GET | /v1/webhooks | Minimal operational surfaces |
| GET | /v1/scheduling/booking-links/{slug} | Embedded booking widget |
| POST | /v1/scheduling/bookings | Embedded booking widget |
| GET | /v1/admin/audit-logs | Minimal operational surfaces |
| GET | /v1/usage | Minimal operational surfaces |
| GET | /v1/connections | Minimal operational surfaces |
| Método | Ruta | Función |
|---|---|---|
| GET | /v1/email/capabilities/{connectionId} | Mailbox connection and capability discovery |
| GET | /v1/email/messages | Search, folders, labels, attachments |
| POST | /v1/email/messages | Messages 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/folders | Search, folders, labels, attachments |
| GET | /v1/email/labels | Search, folders, labels, attachments |
| GET | /v1/email/messages/{messageId}/attachments/{attachmentId} | Search, folders, labels, attachments |
| POST | /v1/email/drafts | Drafts, 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}/send | Drafts, send, replies, tracking |
| POST | /v1/email/send | Drafts, send, replies, tracking |
| GET | /v1/email/tracking/{trackingId} | Drafts, send, replies, tracking |
| POST | /v1/email/sync/start | Incremental sync and mailbox repair |
| GET | /v1/email/sync/changes | Incremental sync and mailbox repair |
| POST | /v1/email/sync/reset | Incremental sync and mailbox repair |
| GET | /v1/email/sync/status/{connectionId} | Incremental sync and mailbox repair |
| GET | /v1/email/templates | Dynamic email templates |
| POST | /v1/email/templates | Dynamic 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}/preview | Dynamic email templates |
| GET | /v1/email/scheduled | Scheduled send |
| GET | /v1/email/scheduled/{scheduledId} | Scheduled send |
| DELETE | /v1/email/scheduled/{scheduledId} | Scheduled send |
| POST | /v1/email/ai/summarize | AI message processing |
| POST | /v1/email/ai/classify | AI message processing |
| POST | /v1/email/ai/extract | AI message processing |
| POST | /v1/email/ai/clean | AI message processing |
Calendar
18 endpoints| Método | Ruta | Función |
|---|---|---|
| GET | /v1/calendars | Calendars and events CRUD |
| POST | /v1/calendars | Calendars and events CRUD |
| GET | /v1/calendars/{calendarId} | Calendars and events CRUD |
| GET | /v1/calendars/{calendarId}/events | Calendars and events CRUD |
| POST | /v1/calendars/{calendarId}/events | Calendars 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/query | Availability and free/busy |
| POST | /v1/calendars/availability/query | Availability and free/busy |
| POST | /v1/calendars/{calendarId}/events/{eventId}/accept | Recurrence, RSVP, reminders, conferencing |
| POST | /v1/calendars/{calendarId}/events/{eventId}/tentative | Recurrence, RSVP, reminders, conferencing |
| POST | /v1/calendars/{calendarId}/events/{eventId}/decline | Recurrence, RSVP, reminders, conferencing |
| POST | /v1/calendars/{calendarId}/events/{eventId}/conference | Recurrence, RSVP, reminders, conferencing |
| POST | /v1/calendars/{calendarId}/sync/start | Incremental sync and watch renewal |
| GET | /v1/calendars/{calendarId}/sync/changes | Incremental sync and watch renewal |
| POST | /v1/calendars/{calendarId}/sync/renew | Incremental sync and watch renewal |
| POST | /v1/calendars/{calendarId}/sync/reset | Incremental sync and watch renewal |
AI Meeting Notetaker
8 endpoints| Método | Ruta | Función |
|---|---|---|
| POST | /v1/recordings/bots | Recorder bot lifecycle |
| GET | /v1/recordings/{recordingBotId}/status | Recorder bot lifecycle |
| DELETE | /v1/recordings/{recordingBotId} | Recorder bot lifecycle |
| GET | /v1/recordings/policy | Recorder dispatch policy |
| PATCH | /v1/recordings/policy | Recorder dispatch policy |
| GET | /v1/recordings/{recordingBotId}/transcript | Transcript and media retrieval |
| GET | /v1/recordings/{recordingBotId}/media | Transcript and media retrieval |
| POST | /v1/recordings/webhook | Recording webhook intake |
Contacts
15 endpoints| Método | Ruta | Función |
|---|---|---|
| GET | /v1/contacts | Contacts CRUD |
| POST | /v1/contacts | Contacts CRUD |
| GET | /v1/contacts/{contactId} | Contacts CRUD |
| PATCH | /v1/contacts/{contactId} | Contacts CRUD |
| DELETE | /v1/contacts/{contactId} | Contacts CRUD |
| GET | /v1/contact-books | Address books, groups, and directories |
| POST | /v1/contact-books | Address 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-groups | Address 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/start | Incremental sync and dedupe assistance |
| GET | /v1/contacts/sync/changes | Incremental sync and dedupe assistance |
| POST | /v1/contacts/merge-suggestions/query | Incremental sync and dedupe assistance |
Tasks
17 endpoints| Método | Ruta | Función |
|---|---|---|
| GET | /v1/task-lists | Task lists and tasks CRUD |
| POST | /v1/task-lists | Task 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}/tasks | Task lists and tasks CRUD |
| POST | /v1/task-lists/{taskListId}/tasks | Task 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-items | Subtasks, 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}/links | Subtasks, checklist items, linked resources |
| POST | /v1/task-lists/{taskListId}/sync/start | Task sync and reconciliation |
| GET | /v1/task-lists/{taskListId}/sync/changes | Task sync and reconciliation |
| POST | /v1/task-lists/{taskListId}/sync/reset | Task sync and reconciliation |
Scheduling and booking
21 endpoints| Método | Ruta | Función |
|---|---|---|
| GET | /v1/scheduling/event-types | Event types, booking profiles, booking links |
| POST | /v1/scheduling/event-types | Event 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/query | Availability search and slot generation |
| POST | /v1/scheduling/holds | Availability 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}/confirm | Create, confirm, reschedule, cancel bookings |
| POST | /v1/scheduling/bookings/{bookingId}/reschedule | Create, confirm, reschedule, cancel bookings |
| POST | /v1/scheduling/bookings/{bookingId}/cancel | Create, confirm, reschedule, cancel bookings |
| POST | /v1/scheduling/pools | Round-robin, pooled, group, routing forms |
| PATCH | /v1/scheduling/pools/{poolId} | Round-robin, pooled, group, routing forms |
| POST | /v1/scheduling/routing-forms | Round-robin, pooled, group, routing forms |
| PATCH | /v1/scheduling/routing-forms/{routingFormId} | Round-robin, pooled, group, routing forms |
| POST | /v1/scheduling/routing-forms/{routingFormId}/responses | Round-robin, pooled, group, routing forms |
| POST | /v1/scheduling/group-bookings | Round-robin, pooled, group, routing forms |
| POST | /v1/scheduling/workflows | Scheduling 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| Método | Ruta | Función |
|---|---|---|
| GET | /v1/meta/openapi | OpenAPI, examples, quickstarts |
| POST | /v1/dev/simulate/event | Sandbox, mocks, webhook inspector |
| POST | /v1/dev/fake-connection | Sandbox, mocks, webhook inspector |
| GET | /v1/meta/postman | OpenAPI, examples, quickstarts |
| GET | /v1/dev/webhook-inspector | Sandbox, mocks, webhook inspector |
| GET | /v1/meta/changelog | Changelog and migration guides |
Migration tools
5 endpoints| Método | Ruta | Función |
|---|---|---|
| GET | /v1/meta/providers | Connector metadata |
| GET | /v1/meta/providers/{provider} | Connector metadata |
| POST | /v1/migrations/import-jobs | Import/export helpers |
| GET | /v1/migrations/import-jobs/{jobId} | Import/export helpers |
| POST | /v1/migrations/export-jobs | Import/export helpers |
API
4 endpoints| Método | Ruta | Función |
|---|---|---|
| GET | /v1/meta/capabilities | Versioned REST surface |
| GET | /v1/connections/{connectionId}/capabilities | Capability introspection and raw passthrough |
| GET | /v1/{resource}/{id}/raw | Capability introspection and raw passthrough |
| POST | /v1/provider-actions/{provider}/{action} | Capability introspection and raw passthrough |
MCP and agent tools
9 endpoints| Método | Ruta | Función |
|---|---|---|
| GET | /v1/mcp/tools | Official MCP server with resource-safe tools |
| POST | /v1/mcp/sessions | Official MCP server with resource-safe tools |
| DELETE | /v1/mcp/sessions/{sessionId} | Official MCP server with resource-safe tools |
| POST | /v1/approvals | Approvals and policy-aware actions |
| POST | /v1/approvals/{approvalId}/approve | Approvals and policy-aware actions |
| POST | /v1/approvals/{approvalId}/reject | Approvals and policy-aware actions |
| GET | /v1/mcp/runs | Durable run history and provenance |
| GET | /v1/mcp/runs/{runId} | Durable run history and provenance |
| POST | /v1/mcp/runs/{runId}/replay | Durable run history and provenance |
Admin and organization
11 endpoints| Método | Ruta | Función |
|---|---|---|
| GET | /v1/orgs | Organizations, users, roles |
| POST | /v1/orgs | Organizations, users, roles |
| GET | /v1/orgs/{orgId}/users | Organizations, users, roles |
| POST | /v1/orgs/{orgId}/users | Organizations, users, roles |
| PATCH | /v1/orgs/{orgId}/users/{userId} | Organizations, users, roles |
| DELETE | /v1/orgs/{orgId}/users/{userId} | Organizations, users, roles |
| GET | /v1/orgs/{orgId}/roles | Organizations, users, roles |
| POST | /v1/orgs/{orgId}/roles | Organizations, users, roles |
| GET | /v1/orgs/{orgId}/policies | Connection policies and domain installs |
| PATCH | /v1/orgs/{orgId}/policies | Connection policies and domain installs |
| POST | /v1/orgs/{orgId}/domain-installs | Connection policies and domain installs |
White-labeling and branding
7 endpoints| Método | Ruta | Función |
|---|---|---|
| GET | /v1/branding | Themes, assets, localized copy |
| PATCH | /v1/branding | Themes, assets, localized copy |
| POST | /v1/custom-domains | Custom domains and sender identities |
| GET | /v1/custom-domains | Custom domains and sender identities |
| POST | /v1/sender-identities | Custom domains and sender identities |
| GET | /v1/sender-identities | Custom domains and sender identities |
| GET | /v1/embed/config/{componentId} | Embeddable components |
Monitoring
2 endpoints| Método | Ruta | Función |
|---|---|---|
| GET | /v1/admin/metrics | Core operational metrics |
| GET | /v1/admin/traces/{traceId} | Tracing and source correlation |
Rate limits
2 endpoints| Método | Ruta | Función |
|---|---|---|
| GET | /v1/usage/limits | Tenant/app quotas |
| PATCH | /v1/usage/limits | Tenant/app quotas |
Billing and usage
3 endpoints| Método | Ruta | Función |
|---|---|---|
| GET | /v1/billing/plans | Plans, invoices, entitlements |
| POST | /v1/billing/subscriptions | Plans, invoices, entitlements |
| GET | /v1/billing/invoices | Plans, invoices, entitlements |
Sync and repair
3 endpoints| Método | Ruta | Función |
|---|---|---|
| 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 |