Sign in

v1

latestOpenAPI 3.0.22026-08-045831103.6 KB
Channel Accounts

List channel accounts

Retrieve a paginated list of channel accounts. By default returns all supported channel types (WHATSAPP_OFFICIAL, WHATSAPP, INSTAGRAM); soft-deleted accounts are always excluded. Use the optional type query parameter to narrow the result to a single channel type.

get/v2/channel-accounts

Query parameters

limitinteger

Max number of rows returned

offsetinteger

Number of rows skipped of the result

pageinteger

Select the page of the result

type'WHATSAPP_OFFICIAL' | 'WHATSAPP' | 'INSTAGRAM'
Example:WHATSAPP_OFFICIAL

Filter channel accounts by type. When omitted, returns all supported channel types (WHATSAPP_OFFICIAL, WHATSAPP, INSTAGRAM).

Headers

api-tokenstring required

API Token

Response

A paginated list of channel accounts

statusinteger

Response status

total_countinteger

Total items based on current filters

pageinteger

Current page

total_pagesinteger

Total pages based on current filters

has_nextboolean

Indicates that has next page

has_previousboolean

Indicates that has previous page

Example response

{
  "status": 200,
  "total_count": 50,
  "page": 1,
  "total_pages": 10,
  "has_next": true,
  "data": [
    {
      "id": "8feade82-d77b-4e8b-9d35-fd43e972b5c8",
      "created_at": "2020-01-01T14:15:00.000000+00:00",
      "name": "WhatsApp Business",
      "type": "WHATSAPP_OFFICIAL",
      "status": "CONNECTED",
      "avatar": "https://example.com/avatar.jpg",
      "identifier": "5548999999999",
      "team_id": "8feade82-d77b-4e8b-9d35-fd43e972b5c8"
    }
  ]
}