API Reference

List active WhatsApp groups

post
https://example.com/api/ext/v3/conversations/groups/list

Returns a cursor-paginated list of active groups.
Optionally filter by channel or specific group IDs; when channel is omitted, the default channel is used.
Use the continuous_token from the response to fetch subsequent pages.
When the token is absent or null in the response, there are no more results.
Only available on the Business plan.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Request body for listing active groups (POST).

string | null

Filter by channel name or phone number (optional, uses default channel if omitted).

group_ids
array of strings | null

Retrieve specific groups by their IDs (optional).
When provided, only groups matching these IDs are returned.

group_ids
string | null

Opaque continuation token from a previous response. Omit for the first page.

int32

Maximum number of groups to return per page (1–100). Default: 20.

Headers
string
enum
Defaults to application/json-patch+json

Generated from available request content types

Allowed:
Responses

401

The request is unauthorized.

429

Too many requests. Either the rate limit has been exceeded or usage limits have been reached.

Updated about 5 hours ago

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

Updated about 5 hours ago