Base URL
/v1):
Authentication
Every request takes a per-brandtoken query parameter. Tokens live in the shared Secrets Store and are accessed server-side (or via MCP) — they are never stored in this repo, so every example here shows token=<token>.
Request conventions
- Method: HTTP
GETfor all reads documented here. A few utilities are “GET-that-mutates” (e.g.setcustomer). - The
/¶mform: several endpoints are called asorders/&orderid=123(a trailing slash then&), notorders/?orderid=123. Both forms work in practice; AAG tools try/&first, then/?. - Filters: list endpoints accept
filter[Field]=value, e.g.filter[AgentReference],filter[Email],filter[Surname].limit=Ncaps the result count. - Dates:
Y-m-dstrings (e.g.2026-02-15).
Response shape
Responses are JSON, commonly wrapped in aresponse key — availability returns { "response": [ EventObject, … ] }, for example. Each endpoint page notes its shape, and the objects page documents the reusable schemas (EventObject, OrderObject, CustomerObject, ProductObject).
Source
Canonical V1 docs live inaust-adventure/API (branch V1, folder Docs/); object schemas are in its appendix.md. This Mintlify section mirrors the endpoints AAG uses plus captured example responses.