Requests and responses

Read the HTTP status, typed JSON payload and request metadata together.

Request

Content-Type: application/json: Send JSON writes with Content-Type: application/json.
data · meta: Successful responses contain data and meta; collection responses additionally describe pagination.
error.code · error.message: Errors contain error.code, error.message and field information where applicable.

Required and nullable are independent.
A required field may legitimately contain null when its schema permits it.
Preserve JSON booleans, integers, strings and null without coercion.
Monetary amounts are decimal strings; do not calculate prices using binary floating point.

Some concurrency versions use signed 64-bit integers.
A JavaScript client must use lossless JSON handling for values beyond Number.MAX_SAFE_INTEGER and send the original integer representation.
Do not round a version or convert it into a JSON string.

Cache-ControlStringOptional: Response cache policy.

const: "no-store"
X-Correlation-IDStringOptional: Identifier used to trace this HTTP request.
WWW-AuthenticateStringOptional: Authentication scheme required by the server.
AllowStringOptional: HTTP methods supported by this resource.
Retry-AfterIntegerOptional: Minimum delay before retrying, in seconds.

minimum: 0
LocationStringOptional: Relative URL of the created resource.