Response Format

Successful responses

Successful responses return their payload under a data key. For example, GET /v1/messaging-channel-connections:

{
  "data": {
    "messaging_channel_connections": [
      {
        "id": 123,
        "name": "Main WhatsApp",
        "messaging_channel_id": "whatsapp",
        "default": true,
        "connected": true
      }
    ]
  }
}

The meta object

Some responses include a meta object alongside data carrying status and pagination information:

{
  "data": { },
  "meta": {
    "message": "Optional human-readable message",
    "message_type": "success",
    "total_results": 42,
    "next_cursor": "eyJpZCI6MTIzfQ",
    "warning": "Optional non-fatal warning"
  }
}

Field	Description
message	Human-readable message about the result.
message_type	One of success, info, warning, error.
total_results	Total number of matching records (where applicable).
next_cursor	Pagination token for the next page. See Pagination.
warning	A non-fatal warning, when present.

Not every endpoint returns a meta object; check the API Reference for each operation's response schema.

Errors

Error responses use a different shape (error + details). See Errors.