v1

latestOpenAPI 3.0.02026-07-2491237338.9 KB
WhatsApp Groups

List groups

Returns a cursor-paginated list of active WhatsApp groups.

get/whatsapp/{businessPhoneNumber}/groups

Path parameters

businessPhoneNumberstring required
Example:+16315551111

The WhatsApp business phone number in E.164 format.

Query parameters

limitinteger

A limit on the number of results to be returned, between 1 and 1024. Defaults to 25.

beforestring
Example:eyJvIjoiYmVmb3JlIn0

A cursor to fetch the previous page.

afterstring
Example:eyJvIjoiYWZ0ZXIifQ

A cursor to fetch the next page.

Response

Successfully retrieved groups.

Example response

{
  "data": [
    {
      "groupId": "120363345678901234@g.us",
      "subject": "New Purchase Inquiry",
      "createdAt": 1739321024
    }
  ],
  "paging": {
    "before": "eyJvIjoiYmVmb3JlIn0",
    "after": "eyJvIjoiYWZ0ZXIifQ"
  }
}