Skip to content

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

ParameterTypeRequiredDescription
client_idnumberNoFilter by client.
wa_idstringNoFilter by WhatsApp number (wa_id).
waba_idstringNoFilter by WABA.
statusstringNoFilter by status.
business_idstringNoFilter by associated business ID (exact match).
business_namestringNoFilter by business name (case-insensitive partial match).
qstringNoFree-text search (case-insensitive) over client_name, waba_name, wa_id and waba_id.
deletedbooleanNoDeleted filter. Absent or false: excludes deleted (default). true: deleted only.
pagenumberNoPage number (default 1).
sizenumberNoPage size (default 20, max 100).
fieldsstringNoComma-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.

FieldDescription
wa_id, client_id, client_name, waba_id, waba_name, statusResource identifiers and status
business_id, business_nameAssociated business
current_limit, quality_rating, phone_id, phone_number_idLimits, quality and phone numbers
is_on_biz_appConfiguration flag
phone_code, phone_numberPhone number data
create_at, create_by, register_atAudit trail
external_webhookAdditional 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

CodeCase
400Invalid parameter (client_id, deleted, page, size not valid numbers/booleans)
403client_id of another client requested without BSP_CN permission