Response Envelope

Notes:

Public API v1 is currently in feature preview and as such documentation for this feature is still work in progress

All successful Public API v1 responses are wrapped in a standard envelope.

Envelope shape

The envelope can include optional metadata fields depending on the endpoint and response state.

Example: pagination available

{
  "data": {},
  "meta": {
    "apiVersion": "1.0",
    "requestId": "00-6b2f90b3a92445f792a2b2a6b4d8e6d0-0a8a7d9b9d8c4e2f-00",
    "correlationId": "3f3cb61b8f5342b4b4f0a3e2e1d0d5b1",
    "workspaceIdentifier": "demo",
    "timestamp": "2026-02-03T05:16:02.000Z",
    "rateLimit": null,
    "pagination": {
      "nextPageLink": "/api/public/v1/connections?page=2&pageSize=50&filter=active"
    }
  }
}

Example: no next page

{
  "data": {},
  "meta": {
    "apiVersion": "1.0",
    "requestId": "00-6b2f90b3a92445f792a2b2a6b4d8e6d0-0a8a7d9b9d8c4e2f-00",
    "correlationId": "3f3cb61b8f5342b4b4f0a3e2e1d0d5b1",
    "workspaceIdentifier": "demo",
    "timestamp": "2026-02-03T05:16:02.000Z",
    "rateLimit": null,
    "pagination": {
      "nextPageLink": null
    }
  }
}

Example: optional metadata omitted

{
  "data": {},
  "meta": {
    "apiVersion": "1.0",
    "requestId": "00-6b2f90b3a92445f792a2b2a6b4d8e6d0-0a8a7d9b9d8c4e2f-00",
    "correlationId": "3f3cb61b8f5342b4b4f0a3e2e1d0d5b1",
    "workspaceIdentifier": "demo",
    "timestamp": "2026-02-03T05:16:02.000Z"
  }
}

Fields

• data contains the response payload for the endpoint.
• meta.apiVersion identifies the API version used to generate the response.
• meta.requestId is the unique request identifier.
• meta.correlationId is the correlation identifier for tracing.
• meta.workspaceIdentifier is the workspace identifier for the request context.
• meta.timestamp is the UTC timestamp when the response was generated.
• meta.rateLimit contains rate limit information when available.
  • When rate limit metadata is not available, meta.rateLimit is returned as null or omitted.
• meta.pagination contains pagination metadata for list responses when paging values are valid.
  • Paging metadata is produced from page, pageSize, and total values in the response payload.
  • meta.pagination.nextPageLink contains a relative URL to the next page when another page is available.
  • When no additional page is available, meta.pagination.nextPageLink is returned as null.
  • When paging values are missing or invalid (page < 1, pageSize < 1, or total < 0), meta.pagination is omitted.