Skip to content

Responses & errors

Typical payloads and status codes. Exact fields are defined per route in the OpenAPI document.

Errors

Many failures return JSON with an error string (and sometimes additional detail keys for validation). Treat non-2xx bodies as structured where Content-Type is JSON.

401 — missing or invalid auth. 403 — authenticated but not allowed (wrong org, RCP, or JWT-only route with an API token).

The global spec description notes that 401/403 follow server behavior, not only whether an operation lists a security scheme.

Pagination & lists

Collection list (GET /collections) and similar list endpoints often return total, limit, and offset alongside the array payload.

Record list supports offset or keyset cursor depending on query parameters. Search ( q), filters, and some modes may disable cursor paging—use offset instead when the spec or response omits nextCursor.

Listing may include auxiliary maps (for example reference labels); see each operation’s description in the spec.

Success shapes

Successful responses are JSON unless documented otherwise (for example exports or binary). For comprehensive request and response schemas, use the interactive spec or OpenAPI JSON.