GET /api/channels/{id} Returns the full details of a single channel, including its configuration and metadata.

​
Headers

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

​
Path parameters

​
id
string
required
The channel ID.

​
Example request

curl https://{appId}.api-{region}.cometchat.io/v3/business-messaging/api/channels/664a1b2c3d4e5f6a7b8c9d0e \
  -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,
  "config": {},
  "createdAt": "2024-01-15T09:30:00.000Z",
  "updatedAt": "2024-01-15T09:30:00.000Z"
}

​
Response fields

​
id
string
Unique channel identifier.
​
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.
​
config
object
Channel-specific configuration.