List a broadcast’s recipients

GET/api/v1/broadcasts/{id}/recipients

scope broadcasts:readPaginated

Per-recipient delivery status, newest first. Filter by status to find failures.

Path parameters

Name	Type	Description
`id`required	`string (uuid)`	Broadcast id

Query parameters

Name	Type	Description
`limit`optional	`integer`	Page size, 1–100Default: `20`
`cursor`optional	`string`	The `next_cursor` from the previous page
`status`optional	`string (enum)`	`pendingsentdeliveredreadrepliedfailed`

Request

curl "https://your-crm.example.com/api/v1/broadcasts/a7b8c9d0-e1f2-4a3b-8c4d-5e6f7a8b9c0d/recipients?status=failed" \
  -H "Authorization: Bearer $RAABTA_API_KEY"

Response · 200 OK

{
  "data": [
    {
      "id": "b8c9d0e1-f2a3-4b4c-8d5e-6f7a8b9c0d1e",
      "contact_id": "9d7e4c11-5a2b-4f7c-8e3d-2a1b0c9d8e7f",
      "contact": {
        "id": "9d7e4c11-5a2b-4f7c-8e3d-2a1b0c9d8e7f",
        "name": "Ayesha Khan",
        "phone": "+971501234567"
      },
      "status": "failed",
      "channel_message_id": null,
      "error": "Recipient phone number not in allowed list",
      "sent_at": null,
      "delivered_at": null,
      "read_at": null,
      "replied_at": null,
      "created_at": "2026-09-02T10:00:00.000Z"
    }
  ],
  "meta": {
    "next_cursor": null,
    "has_more": false,
    "limit": 20
  }
}

Response

Wrapped in { data: [...], meta }

Name	Type	Description
`id`required	`string (uuid)`	UUID
`contact_id`required	`string (uuid) \| null`
`contact`required	`object \| null`	The recipient, or null if the contact was deleted
`contact.id`required	`string (uuid)`	UUID
`contact.name`required	`string \| null`	Display name
`contact.phone`required	`string \| null`	E.164 phone number, when the channel has one
`status`required	`string (enum)`	Forward-only ladder; failed only from an early state`pendingsentdeliveredreadrepliedfailed`
`channel_message_id`required	`string \| null`	The channel’s own id for this send
`error`required	`string \| null`	Why the send failed, when it did
`sent_at`required	`string (date-time) \| null`
`delivered_at`required	`string (date-time) \| null`
`read_at`required	`string (date-time) \| null`
`replied_at`required	`string (date-time) \| null`
`created_at`required	`string (date-time)`	ISO 8601 timestamp

Errors

Status	Code	When
400	`bad_request`	The request could not be parsed: malformed JSON, an invalid cursor, or a query parameter of the wrong shape.
400	`validation_error`	The body or query failed validation. `details` lists each failing field with a `path` and a `message`.
401	`unauthorized`	No usable API key: the Authorization header is missing or malformed, or the key is unknown, revoked or expired. The three are deliberately indistinguishable.
403	`forbidden`	The key is valid but lacks the scope this endpoint requires, or the request came from an address outside the key’s IP allowlist. The message says which.
403	`account_suspended`	The account this key belongs to is suspended. Rotating the key will not help; contact support.
404	`not_found`	No such resource in this account. A resource that exists in another account also returns this.
429	`rate_limited`	The per-key budget, or the per-IP budget for failed authentication, is exhausted. Honour `Retry-After` before retrying.
500	`internal`	Something failed on our side. Safe to retry with the same Idempotency-Key; quote `request_id` if it persists.