Authorizations
Your project API key
Query Parameters
Required range:
x >= 1
Required range:
1 <= x <= 100
Filter by exact WhatsApp config ID
Filter by exact template ID
curl --request GET \
--url https://app.kapso.ai/api/v1/whatsapp_broadcasts \
--header 'X-API-Key: <api-key>'
{
"data": [
{
"id": "5f6a7b8c-9d0e-1f2a-3b4c-5d6e7f8a9b0c",
"name": "July Promo",
"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",
"whatsapp_config_id": "4a5b6c7d-8e9f-0a1b-2c3d-4e5f6a7b8c9d",
"whatsapp_template": {
"id": "7a8b9c0d-1e2f-3a4b-5c6d-7e8f9a0b1c2d",
"name": "july_promo_template",
"language_code": "en_US",
"category": "MARKETING",
"status": "approved"
},
"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,
"stats": {
"total": 1000,
"sent": 950,
"failed": 50,
"delivered": 900,
"read": 750,
"responded": 120,
"pending": 0
}
},
{
"id": "3c4d5e6f-7a8b-9c0d-1e2f-3a4b5c6d7e8f",
"name": "Summer Sale",
"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",
"whatsapp_config_id": "4a5b6c7d-8e9f-0a1b-2c3d-4e5f6a7b8c9d",
"whatsapp_template": {
"id": "9d0e1f2a-3b4c-5d6e-7f8a-9b0c1d2e3f4a",
"name": "summer_sale_template",
"language_code": "en_US",
"category": "MARKETING",
"status": "approved"
},
"total_recipients": 500,
"sent_count": 250,
"failed_count": 10,
"delivered_count": 240,
"read_count": 100,
"responded_count": 15,
"pending_count": 240,
"response_rate": 6,
"stats": {
"total": 500,
"sent": 250,
"failed": 10,
"delivered": 240,
"read": 100,
"responded": 15,
"pending": 240
}
}
],
"meta": {
"page": 1,
"per_page": 20,
"total_pages": 1,
"total_count": 2
}
}
Get all broadcasts for your project with optional filtering.
Returns broadcasts ordered by most recent first.
curl --request GET \
--url https://app.kapso.ai/api/v1/whatsapp_broadcasts \
--header 'X-API-Key: <api-key>'
{
"data": [
{
"id": "5f6a7b8c-9d0e-1f2a-3b4c-5d6e7f8a9b0c",
"name": "July Promo",
"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",
"whatsapp_config_id": "4a5b6c7d-8e9f-0a1b-2c3d-4e5f6a7b8c9d",
"whatsapp_template": {
"id": "7a8b9c0d-1e2f-3a4b-5c6d-7e8f9a0b1c2d",
"name": "july_promo_template",
"language_code": "en_US",
"category": "MARKETING",
"status": "approved"
},
"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,
"stats": {
"total": 1000,
"sent": 950,
"failed": 50,
"delivered": 900,
"read": 750,
"responded": 120,
"pending": 0
}
},
{
"id": "3c4d5e6f-7a8b-9c0d-1e2f-3a4b5c6d7e8f",
"name": "Summer Sale",
"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",
"whatsapp_config_id": "4a5b6c7d-8e9f-0a1b-2c3d-4e5f6a7b8c9d",
"whatsapp_template": {
"id": "9d0e1f2a-3b4c-5d6e-7f8a-9b0c1d2e3f4a",
"name": "summer_sale_template",
"language_code": "en_US",
"category": "MARKETING",
"status": "approved"
},
"total_recipients": 500,
"sent_count": 250,
"failed_count": 10,
"delivered_count": 240,
"read_count": 100,
"responded_count": 15,
"pending_count": 240,
"response_rate": 6,
"stats": {
"total": 500,
"sent": 250,
"failed": 10,
"delivered": 240,
"read": 100,
"responded": 15,
"pending": 240
}
}
],
"meta": {
"page": 1,
"per_page": 20,
"total_pages": 1,
"total_count": 2
}
}
Your project API key
x >= 1
1 <= x <= 100
Filter by exact WhatsApp config ID
Filter by exact template ID
Was this page helpful?