List Channels

GET/v1/conversations/channels

Retrieves a paginated list of all active communication channels in the workspace.

Query Parameters

pageinteger

Example:1

limitinteger

Example:25

Responses

Body

success_codeenum: 200 | 201•Numeric success code matching the HTTP response status. required

Example:200

messagestring required

Example:OK

detailsobject required

dataarray[object] required

idstring

Example:60f8888887890abcdef12345

namestring

Example:Official WhatsApp

channel_typestring

Example:whatsapp

is_activeboolean

Example:true

metaobject

error_codeinteger•Numeric error code matching the HTTP response status. required

Example:400

messagestring required

detailsobject•Validation errors are returned as a field-to-messages map; other errors may use arbitrary keys. required

error_codeinteger•Numeric error code matching the HTTP response status. required

Example:400

messagestring required

detailsobject•Validation errors are returned as a field-to-messages map; other errors may use arbitrary keys. required

error_codeinteger•Numeric error code matching the HTTP response status. required

Example:400

messagestring required

detailsobject•Validation errors are returned as a field-to-messages map; other errors may use arbitrary keys. required

Request Sample:Shell / cURL

1
2
3
4

curl --request GET \
  --url "https://api-stg.bevatelcloud.com/v1/conversations/channels?page=1&limit=25" \
  --header "Authorization: Bearer <YOUR_API_KEY>" \
  --header "Content-Type: application/json"

Response Example

1
2
3
4
5
6
7
8
9
10
11
12
13
14

{
  "success_code": 200,
  "message": "OK",
  "details": {},
  "data": [
    {
      "id": "60f8888887890abcdef12345",
      "name": "Official WhatsApp",
      "channel_type": "whatsapp",
      "is_active": true
    }
  ],
  "meta": {}
}