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

List Campaigns

API Documentation / WhatsApp / List Campaigns

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

GET /api/whatsapp/v1/campaigns

Your campaigns, newest first.

Parameters

Param Type Required Notes
status string no Filter by status.
per_page integer no Max 200.

Request example

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

Success response (data)

{
    "campaigns": [
        {
            "uid": "WCPFH2VWMY9ZA",
            "name": "Diwali offer",
            "channel": "WCH54DZ7M7M5V",
            "status": "running",
            "pause_reason": null,
            "template": {
                "name": "diwali_offer",
                "language": "en",
                "category": "marketing"
            },
            "counters": {
                "total_recipients": 5000,
                "queued_count": 4870,
                "submitted_count": 2300,
                "sent_count": 2210,
                "delivered_count": 2100,
                "read_count": 900,
                "failed_count": 12,
                "skipped_count": 130,
                "cancelled_count": 0
            },
            "exclusions": {
                "skipped_optout": 80,
                "skipped_invalid": 40,
                "skipped_duplicate": 10
            },
            "amounts": {
                "estimated": 6574.5,
                "charged": 3105,
                "refunded": 13.5
            },
            "warning": null,
            "last_error": null,
            "scheduled_at": null,
            "started_at": "2026-10-10T09:00:03+00:00",
            "completed_at": null,
            "created_at": "2026-10-10T08:59:40+00:00"
        }
    ],
    "pagination": {
        "page": 1,
        "per_page": 25,
        "total": 1,
        "total_pages": 1
    }
}

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