List Connected Channels via the ChatbotX REST API

Channels (also called inboxes) represent the messaging platforms connected to your ChatbotX workspace, such as WhatsApp, Messenger, Instagram, Telegram, and more. Use this endpoint to list all connected channels along with their type and current connection status. This is useful for mapping channel IDs when creating contacts, broadcasts, or routing rules.

GET /api/v1/channels

Query Parameters

integer

The page number to retrieve. Must be 1 or greater. Defaults to 1.

integer

Number of channels to return per page. Must be 1 or greater.

array

Optional array of related resources to include in the response.

Code Examples

curl --request GET \
  --url 'https://app.chatbotx.io/api/v1/channels?page=1&perPage=20' \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://app.chatbotx.io/api/v1/channels"

params = {"page": 1, "perPage": 20}
headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, params=params, headers=headers)
print(response.json())

const options = {
  method: 'GET',
  headers: { Authorization: 'Bearer <token>' }
};

fetch('https://app.chatbotx.io/api/v1/channels?page=1&perPage=20', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

Response

Returns 200 OK with a data array of channel objects and a pageCount for pagination.

Response Fields

array

required

Array of channel objects connected to the workspace.

Show data item fields

string

required

Unique identifier for the channel.

string

required

Display name of the channel or inbox.

string

required

The messaging platform type. Common values include messenger, whatsapp, instagram, telegram, webchat, and email.

string

required

The current connection status of the channel, such as connected or disconnected.

number

required

The total number of pages available based on the current perPage value.

Example Response

{
  "data": [
    {
      "id": "ch_001",
      "name": "WhatsApp Business",
      "channel": "whatsapp",
      "status": "connected"
    },
    {
      "id": "ch_002",
      "name": "Facebook Page Inbox",
      "channel": "messenger",
      "status": "connected"
    },
    {
      "id": "ch_003",
      "name": "Instagram DMs",
      "channel": "instagram",
      "status": "disconnected"
    }
  ],
  "pageCount": 1
}

⌘I

Overview

Contacts

Custom Fields

Tags

Flows & Sequences

Broadcasts & Channels

Workspace

AI Agents

List Connected Channels via the ChatbotX REST API

Query Parameters

Code Examples

Response

Response Fields

Example Response

​Query Parameters

​Code Examples

​Response

​Response Fields

​Example Response

Query Parameters

Code Examples

Response

Response Fields

Example Response