List WhatsApp groups

Returns your WhatsApp groups on one WABA number, 30 per page, newest first.

Before you call

  • wabaNumber must be a connected number in your organization.
  • The API key's user needs permission to view WhatsApp group info on that number.
  • For later pages, pass lastGroupId and olderThanTimestamp from the previous response.

How it works

  • Each group has groupId, subject, description, totalParticipantCount, inviteLink, status and groupCreatedAt.
  • Each group's lastMessage is its latest customer or agent message, shaped like a Get chat messages for a WhatsApp group message, or null.
  • System notices and message types that endpoint does not return are skipped for lastMessage.
  • hasMore tells you whether another page exists; the cursors are null on the last page.
  • Every page carries planDetails (plan name, status, renewal date as on the billing screen), or null when there is no plan or it could not be read.

Rate limit

  • 30 requests per minute.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required

WABA number to list groups for

string

groupId of the last group from the previous page (pagination cursor)

date-time

ISO 8601 timestamp — only return groups created before this time (pagination cursor)

Responses

400

Missing wabaNumber or no integration found for the given WABA number

403

The wabaNumber is not a connected WhatsApp number of the API key's organization, or the API key lacks permission to view its groups

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