Base URLs
Auth is the same everywhere:
Authorization: Bearer <token> with an API key or JWT. An Email call names the email server it is for with the Email-Box-SID header (em_bx_..., from POST /api/email-boxes/search on ID and Teams); without it the call goes to the workspace’s primary server. See Email servers and mailboxes. The playground on each page can send real requests; point it at production and use a test team.
Reading an operation
Beyond the request and response schemas, each operation carries flags from the registry. They render in the description and asx-gtm-* extensions in the raw spec, so both a person and a client generator can act on them:
Deprecated means “not yet”, not “going away”
Operations marked deprecated arestub_501 endpoints: they validate the full request and then answer 501 not_implemented. The request contract is final, so you can build against it today; the marker exists so a generated client tells you not to ship against it yet. The reason is in the operation’s description.
Two serialization details
- On
GETandDELETE, object parameters (filter,sort) travel as JSON text in the query string, and array parameters repeat asname[]=value. Details in Pagination and filtering. - Success and error bodies are envelopes shared by every endpoint. Details in Envelopes and errors.