List channels

GET/v1/channels

Authorization

bearerAuthbearerAuthrequired

apiKeyAuthapiKeyAuthrequired

Query parameters

limitinteger<int32>

Results per page

min 1 · max 100 · default: 20

offsetinteger<int32>

Offset for pagination

min 0 · default: 0

Responses

200OK

itemsChannelItem[] | nullrequired

Show properties

Array of ChannelItem

configany

created_atstringrequired

health_statestring

Operator-facing health: healthy, auth_required, degraded, setup_required

idstringrequired

is_activebooleanrequired

last_connected_atstring | nullrequired

last_errorstring | nullrequired

last_failure_classstring

auth, payload, operational (support)

linked_channel_idstring | nullrequired

metadataanyrequired

modestringrequired

namestringrequired

operator_messagestring

Safe message for workspace UI; never raw Meta errors

organization_idstringrequired

phone_numberstring | nullrequired

platformstringrequired

statusstringrequired

updated_atstringrequired

metaPaginationMetarequired

Show properties

cursorstring

has_morebooleanrequired

limitinteger<int64>required

next_cursorstring

offsetinteger<int64>

totalinteger<int64>

400Bad Request

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

401Unauthorized

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

403Forbidden

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

422Unprocessable Entity

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

500Internal Server Error

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

Request

curl -X GET "/v1/channels"

const response = await fetch("/v1/channels", {
  method: "GET"
});

import requests

response = requests.get(
    "/v1/channels",
)

Response

{
  "items": [
    {
      "config": "string",
      "created_at": "string",
      "health_state": "string",
      "id": "string",
      "is_active": true,
      "last_connected_at": "string",
      "last_error": "string",
      "last_failure_class": "string",
      "linked_channel_id": "string",
      "metadata": "string",
      "mode": "string",
      "name": "string",
      "operator_message": "string",
      "organization_id": "string",
      "phone_number": "string",
      "platform": "string",
      "status": "string",
      "updated_at": "string"
    }
  ],
  "meta": {
    "cursor": "string",
    "has_more": true,
    "limit": 0,
    "next_cursor": "string",
    "offset": 0,
    "total": 0
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}