Skip to main content
GET
/
whatsapp
/
broadcasts
/
{broadcast_id}
/
recipients
List recipients
curl --request GET \
  --url https://api.kapso.ai/platform/v1/whatsapp/broadcasts/{broadcast_id}/recipients \
  --header 'X-API-Key: <api-key>'
{
  "data": [
    {
      "id": "8c9d0e1f-2a3b-4c5d-6e7f-8a9b0c1d2e3f",
      "phone_number": "14155550123",
      "status": "sent",
      "sent_at": "2025-07-15T10:05:23Z",
      "delivered_at": "2025-07-15T10:05:30Z",
      "read_at": "2025-07-15T10:12:45Z",
      "responded_at": "2025-07-15T10:15:00Z",
      "created_at": "2025-07-15T10:00:00Z",
      "updated_at": "2025-07-15T10:15:00Z",
      "template_parameters": {
        "first_name": "Alicia",
        "discount_code": "SAVE25"
      }
    },
    {
      "id": "7b8c9d0e-1f2a-3b4c-5d6e-7f8a9b0c1d2e",
      "phone_number": "14155550124",
      "status": "failed",
      "sent_at": "2025-07-15T10:05:30Z",
      "failed_at": "2025-07-15T10:05:32Z",
      "error_message": "Invalid phone number",
      "error_details": {
        "error_code": "131047",
        "error_subcode": "2494055"
      },
      "created_at": "2025-07-15T10:00:10Z",
      "updated_at": "2025-07-15T10:05:32Z"
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 20,
    "total_pages": 1,
    "total_count": 2
  }
}

Authorizations

X-API-Key
string
header
required

Path Parameters

broadcast_id
string<uuid>
required

Query Parameters

per_page
integer
Required range: x >= 1
page
integer
Required range: x >= 1

Response

OK

data
object[]
required
meta
object
required