Ricky logorickyDocs

List broadcast recipients

GET
/broadcasts/{broadcast_id}/recipients

Each number of the broadcast and where its message stands, in number order. Statuses change as WhatsApp reports them.

Scope: broadcasts:read.

Authorization

bearerAuth
headerAuthorizationBearer <token>

An organization API key, rky_live_…, created in Settings → API. Send it only from a server.

Path Parameters

broadcast_id*string

Broadcast ID.

Formatuuid

Query Parameters

page_size?integer

Items per page.

Range1 <= value <= 100
Default50
cursor?string

next_cursor from the previous page. Use it unchanged.

Lengthlength <= 2048
status?string

Only recipients in this delivery status.

Value in"pending""sent""delivered""read""failed"

Response Body

Success.

application/json
  1. response
data*array<>
next_cursor*|

Pass as cursor for the next page; null on the last page.

curl -X GET 'https://getricky.ai/api/v1/broadcasts/497f6eca-6276-4993-bfeb-53cbbbba6f08/recipients'
{  "data": [    {      "id": "1d2e3f4a-5b6c-4d7e-9f8a-0b1c2d3e4f5a",      "phone": "+50760001234",      "contact_id": "3f6c2b1e-8d4a-4b7e-9a51-2c7d8e9f0a1b",      "status": "pending",      "failure_reason": null,      "conversation_id": "9b2e4c61-7a3f-4d18-b5c2-6e0f1a2b3c4d",      "message_id": "c41d7e2a-5b6f-4a89-8c3d-0e1f2a3b4c5d",      "processed_at": "2026-10-14T15:30:00.000Z",      "status_updated_at": "2026-10-14T15:30:00.000Z"    }  ],  "next_cursor": "string"}