Skip to main content
GET
/
whatsapp
/
broadcasts
List broadcasts
curl --request GET \
  --url https://api.kapso.ai/platform/v1/whatsapp/broadcasts \
  --header 'X-API-Key: <api-key>'
{
  "data": [
    {
      "id": "5f6a7b8c-9d0e-1f2a-3b4c-5d6e7f8a9b0c",
      "name": "Weekend Sale 2025",
      "status": "completed",
      "started_at": "2025-07-15T10:00:00Z",
      "completed_at": "2025-07-15T11:30:00Z",
      "created_at": "2025-07-14T15:00:00Z",
      "updated_at": "2025-07-15T11:30:00Z",
      "phone_number_id": "1234567890",
      "whatsapp_template": {
        "id": "784203120908608",
        "meta_template_id": "784203120908608",
        "name": "weekend_sale_2025",
        "language_code": "en_US",
        "category": "MARKETING",
        "status": "approved",
        "components": [
          {
            "type": "BODY",
            "text": "Hi {{name}}! Get {{discount}}% off this weekend only!",
            "example": {
              "body_text_named_params": [
                {
                  "param_name": "name",
                  "example": "John"
                },
                {
                  "param_name": "discount",
                  "example": "25"
                }
              ]
            }
          }
        ]
      },
      "total_recipients": 1000,
      "sent_count": 950,
      "failed_count": 50,
      "delivered_count": 900,
      "read_count": 750,
      "responded_count": 120,
      "pending_count": 0,
      "response_rate": 12.6
    },
    {
      "id": "3c4d5e6f-7a8b-9c0d-1e2f-3a4b5c6d7e8f",
      "name": "Product Launch Q3",
      "status": "sending",
      "started_at": "2025-07-16T09:00:00Z",
      "completed_at": null,
      "created_at": "2025-07-16T08:00:00Z",
      "updated_at": "2025-07-16T09:15:00Z",
      "phone_number_id": "0987654321",
      "whatsapp_template": {
        "id": "891234567890123",
        "meta_template_id": "891234567890123",
        "name": "product_launch_q3",
        "language_code": "en_US",
        "category": "MARKETING",
        "status": "approved",
        "components": [
          {
            "type": "BODY",
            "text": "New product alert! Check out our Q3 launch."
          }
        ]
      },
      "total_recipients": 500,
      "sent_count": 250,
      "failed_count": 10,
      "delivered_count": 240,
      "read_count": 100,
      "responded_count": 15,
      "pending_count": 240,
      "response_rate": 6
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 20,
    "total_pages": 1,
    "total_count": 2
  }
}

Authorizations

​
X-API-Key
string
header
required

Query Parameters

​
phone_number_id
string

Filter by phone number

​
status
enum<string>

Filter by status

Available options:
draft,
sending,
completed,
failed
​
created_after
string<date-time>
​
created_before
string<date-time>
​
per_page
integer
Required range: x >= 1
​
page
integer
Required range: x >= 1

Response

OK

​
data
object[]
required
​
meta
object
required