Skip to main content
flag
Mon - Fri   10:00 – 18:00

List Groups

API Documentation / WhatsApp / List Groups

Base URL for your account: https://cpaas.studio

GET /api/whatsapp/v1/groups

Your contact groups (campaign audiences).

No parameters.

Request example

curl -X GET "https://cpaas.studio/api/whatsapp/v1/groups" \
  -H "X-API-KEY: cpk_xxxxxxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

Success response (data)

{
    "groups": [
        {
            "uid": "WGR4K7Q2M9X",
            "name": "Kerala customers",
            "description": null,
            "contacts_count": 1250
        }
    ],
    "pagination": {
        "page": 1,
        "per_page": 50,
        "total": 1,
        "total_pages": 1
    }
}

Need more context? See Getting started for authentication, the response envelope, and the full error-code reference.