Skip to main content
The API base URL is:
Use Bearer authentication and Content-Type: application/json for JSON bodies. The OpenAPI document describes endpoint parameters and request schemas. The documentation lives at /docs; API calls do not use that prefix.

Responses

Resource creation can return a resource directly. Email sends and phone operations return an operation ID and statusUrl. Use the returned shape rather than assuming every mutation returns the created message. Message lists contain summaries. Retrieve an individual message to read its text and attachments.

Pagination

Lists use cursor, limit, data, and nextCursor. Treat cursor values as opaque. The maximum page size is 100. For resource lists, stop when nextCursor is null. A deleted or inaccessible cursor can return invalid_cursor; restart the listing if needed. Events use a different checkpoint rule: preserve your last cursor when an empty poll returns null. See event polling.

Administration

API keys and delegated OAuth cover resource operations. Billing, key administration, webhook configuration, and approval decisions require an authorized human session. The endpoint reference identifies these restrictions; a broader API-key scope does not bypass them.