List WhatsApp Groups

List your organisation's WhatsApp groups on WHATSAPP_OFFICIAL channels (most recently active first), optionally filtered to one channel via ?channelId=. Paginate with limit (default 50, max 100) and offset; hasMore indicates another page exists. Deleted groups remain listed with deleted: true. Group chats on other channel types are not part of this API (they still appear in the Chats endpoints with chatType: "group").

Security:

  • The organisationId in the URL must match the organisation your JWT was issued for — requests for a different organisation fail with 401.
  • Requires CRM_ADMIN, ACCOUNT_OWNER, or CRM_BOT role; other roles receive 403.
  • Groups are only supported on WHATSAPP_OFFICIAL channels whose number is an Official Business Account (OBA); ineligible numbers receive 422.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Your organisation UUID (returned as org from the /token endpoint).

Query Params
string

Filter to a single WHATSAPP_OFFICIAL channel.

number

Page size (1-100, default 50).

number

Offset (default 0).

Responses

401

Unauthorized

403

Forbidden — role not permitted

429

Too many requests

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json