List groups

Returns the WhatsApp groups that belong to the app, with cursor-based pagination via the limit, after, and before parameters.

Request parameters

Path parameters

KeyDescriptionValuesData TypeRequired/Optional
appIdIdentifier of the WhatsApp app the call acts on.6f414190-d45c-4671-bca1-fb6c3018cb13StringRequired

Query parameters

KeyDescriptionValuesData TypeRequired/Optional
limitMaximum number of records to return in one page.20StringOptional
afterCursor returned by a previous page; fetches the records after it.—StringOptional
beforeCursor returned by a previous page; fetches the records before it.—StringOptional

Sample cURL — List groups.

curl --request GET \
  --url 'https://partner.gupshup.io/partner/bizgate/app/6f414190-d45c-4671-bca1-fb6c3018cb13/group?limit=20' \
  --header 'Authorization: Bearer <UT>' \
  --header 'Accept: application/json'

Sample success response (200)

{
  "status": "success",
  "data": {
    "data": [
      {
        "creation_timestamp": 1761899043,
        "id": "Y2FwaV9ncm91cDo5MTg5Mjk4NzQyNzg6MTIwMzYzNDIwMTAzNzg0MjA5",
        "subject": "Test PP Grup 2"
      },
      {
        "creation_timestamp": 1761886978,
        "id": "Y2FwaV9ncm91cDo5MTg5Mjk4NzQyNzg6MTIwMzYzNDIxNzc0NTUxMDcy",
        "subject": "New Partner Group"
      }
    ],
    "paging": {
      "cursors": {
        "after": "eyJvZAmZAzZAXQiOjEsInZAlcnNpb25JZACI6IjE3NjE5MDMzMDM2NTE5NDM5MjcifQ",
        "before": "eyJvZAmZAzZAXQiOjAsInZAlcnNpb25JZACI6IjE3NjE5MDMzMDM2NTE5NDM5MjcifQ"
      }
    }
  }
}
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Identifier of the WhatsApp app the call acts on.

Query Params
string

Maximum number of records to return in one page.

string

Cursor returned by a previous page; fetches the records after it.

string

Cursor returned by a previous page; fetches the records before it.

Responses

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