List client WhatsApp channels
Lists the WhatsApp channels of the clients connected to the platform (number with its WABA, associated business, limits, quality and status) with filters, pagination and field selection. Any authenticated supervisor can list: without the BSP_CN permission only the channels of the token’s own client are returned; with BSP_CN you can filter by any client_id or omit it to list all clients.
Endpoint: GET /v1/client-whatsapp-channels
Parameters
Query
| Parameter | Type | Required | Description |
|---|---|---|---|
client_id | number | No | Filter by client. |
wa_id | string | No | Filter by WhatsApp number (wa_id). |
waba_id | string | No | Filter by WABA. |
status | string | No | Filter by status. |
business_id | string | No | Filter by associated business ID (exact match). |
business_name | string | No | Filter by business name (case-insensitive partial match). |
q | string | No | Free-text search (case-insensitive) over client_name, waba_name, wa_id and waba_id. |
deleted | boolean | No | Deleted filter. Absent or false: excludes deleted (default). true: deleted only. |
page | number | No | Page number (default 1). |
size | number | No | Page size (default 20, max 100). |
fields | string | No | Comma-separated fields to return (see Fields). |
Fields
Unknown fields are silently discarded. If fields is absent or all fields are unknown, the default set is returned.
| Field | Description |
|---|---|
wa_id, client_id, client_name, waba_id, waba_name, status | Resource identifiers and status |
business_id, business_name | Associated business |
current_limit, quality_rating, phone_id, phone_number_id | Limits, quality and phone numbers |
is_on_biz_app | Configuration flag |
phone_code, phone_number | Phone number data |
create_at, create_by, register_at | Audit trail |
external_webhook | Additional configuration |
Default fields: wa_id,client_id,client_name,waba_id,waba_name,status,business_id,business_name.
Request
curl --request GET \
--url 'https://api.chattigo.com/v1/client-whatsapp-channels?client_id=6&deleted=false&size=20&page=1&fields=wa_id,client_name,business_id,business_name,status' \
--header 'Authorization: Bearer <token>'Response
Success (200)
{
"data": [
{
"wa_id": "573012345678",
"client_name": "Demo Client",
"business_id": "biz-123",
"business_name": "Demo Business",
"status": "ACTIVE"
}
],
"total": 1,
"page": 1,
"page_size": 20,
"fields": "wa_id,client_name,business_id,business_name,status"
}Errors
| Code | Case |
|---|---|
400 | Invalid parameter (client_id, deleted, page, size not valid numbers/booleans) |
403 | client_id of another client requested without BSP_CN permission |