Guides
Errors, pagination, and idempotency
Machine-readable codes, request IDs, and retry guidance.
Envelope
Success responses include data and meta.requestId. Errors include error.code, error.message, and the same request id. Echo X-Request-Id if you send one.
Status codes
400validation or missing tenant/user headers401missing or invalid key403permission, entitlement, expired key, or sandbox mismatch404unknown resource or disabled module409idempotency key reused with a different body429rate limit — honorRetry-AfterandRateLimit-*
Pagination
List endpoints accept limit and offset. Prefer cursor when present for stable pages.
Idempotency
Mutations accept Idempotency-Key. The same key and body replay the stored result for 24 hours. A different body with the same key returns 409.