Response envelope

Every response — success or error — uses the same top-level shape.

Envelope shape

{
  "data":     <object | array | null>,
  "error":    <object | omitted>,
  "metadata": {
    "requestId":    "req_01HX...",
    "responseTime": 42,
    "timestamp":    "2026-05-18T12:34:56Z",
    "version":      "v1",
    "pagination":   <object | omitted>
  }
}

X-Request-Id is also returned as a response header. Quote it when contacting support.