API reference
API reference
The REST reference, generated from the OpenAPI document.
The reference is generated from the OpenAPI document, and that document is written against the backend — which does not exist yet. Until it does, this page is a placeholder rather than a reference with gaps in it.
What is documented today is in Platform, which describes the endpoints as they are designed and as the mock app implements them. The shapes there are the ones the reference will carry.
Base URL and auth
https://api.aux0.com/v1curl https://api.aux0.com/v1/accounts \
-H "Authorization: Bearer $AUX0_API_KEY"Conventions
- Ids are prefixed by type:
acc_,cht_,msg_,thr_,eml_,prf_,whk_,key_. The prefix is part of the id. - Lists are cursor-paged:
{ items, cursor, total }. Passcursorback for the next page; its absence means the last one. - Times are ISO 8601 in UTC.
- Errors carry a
code, amessageand arequest_id. See Errors.
When this fills in
The changelog says what shipped. This page will carry the generated reference the week the API is live, not before.