Skip to main content
Every endpoint returns the same JSON envelope, so you can write your handling once and reuse it everywhere.

Success

  • data — the result for the endpoint. Its shape is documented per endpoint in the API Reference.
  • meta — metadata about the request itself (below).

meta fields

Errors

Errors use a parallel shape with a matching HTTP status:
Switch on error.code (stable and machine-readable), show error.message to humans, and log requestId. See Errors for the full list of codes.

Timestamps & IDs

  • All timestamps are ISO 8601 UTC strings (e.g. 2026-09-14T09:00:00.000Z).
  • Treat all IDs as opaque strings — don’t parse or infer meaning from them.