Envelope

Every JSON response is wrapped in a standard envelope. The body field carries the actual payload; the surrounding keys are metadata (version, status code, request id, and — on paginated endpoints — a pagination block).

This shape keeps the body abstract so the wrapper is easy to see. Every endpoint returns these envelope keys around its own body:

Envelope fields

• version — API version string.
• code / status — HTTP status code and its text.
• request_id — opaque id for the request; quote it in bug reports.
• elapsed — server-side processing time in seconds.
• pagination — present only on list endpoints (see Pagination).
• body — the actual payload. Its shape is documented on each endpoint's own page.

Condensing

All endpoints support the global &condense=true|false option. When true, all null values are removed from the response; otherwise every possible key is included. It defaults to true.

condense is a boolean, so true/false, 1/0, and yes/no are all accepted.