GET /api/channels Returns a list of all channels for the authenticated app. Each channel includes a templateCount indicating how many templates are linked to it.

​
Headers

​
appid
string
required
Your CometChat App ID.
​
apikey
string
required
Your CometChat API Key.

​
Example request

curl https://{appId}.api-{region}.cometchat.io/v3/business-messaging/api/channels \
  -H "appid: YOUR_APP_ID" \
  -H "apikey: YOUR_API_KEY"

​
Example response

[
  {
    "id": "664a1b2c3d4e5f6a7b8c9d0e",
    "appId": "YOUR_APP_ID",
    "name": "In-App Alerts",
    "key": "in-app-alerts",
    "type": "in_app",
    "templateType": "ui",
    "enabled": true,
    "categoryFilter": false,
    "templateLabel": false,
    "templateCount": 5,
    "config": {},
    "createdAt": "2024-01-15T09:30:00.000Z",
    "updatedAt": "2024-01-15T09:30:00.000Z"
  }
]

​
Response fields

​
id
string
Unique channel identifier.
​
appId
string
Your CometChat App ID.
​
name
string
Channel display name.
​
key
string
Immutable slug generated from the channel name.
​
type
string
Channel type: in_app, push, sms, email, whatsapp, or custom.
​
templateType
string
Either ui or data.
​
enabled
boolean
Whether the channel is active for delivery.
​
templateCount
integer
Number of templates linked to this channel.
​
config
object
Channel-specific configuration.
​
createdAt
string
ISO 8601 creation timestamp.
​
updatedAt
string
ISO 8601 last update timestamp.