ApiSuccessEnvelope

data objectrequired

The resource payload. Shape is endpoint-specific — check the operation description for the concrete DTO. When the endpoint is a list, data is an array.

oneOf

• object
• object[]

object

meta objectrequired

requestIdstringrequired

Correlation id — matches the req.id on every structured log line for this request. Hand to platform operations to trace a specific call end-to-end.

Example: req_89a15a56-52e8-42c9-b52d-a8d7ed1bd90c

pagination object

Present on list endpoints.

pageinteger

Example: 1

pageSizeinteger

Example: 20

totalinteger

Example: 42

ApiSuccessEnvelope

{
  "data": {},
  "meta": {
    "requestId": "req_89a15a56-52e8-42c9-b52d-a8d7ed1bd90c",
    "pagination": {
      "page": 1,
      "pageSize": 20,
      "total": 42
    }
  }
}