List broadcast recipients
Authorization
Bearer AuthorizationBearer <token>
API key (rlay_live_* or rlay_test_). Invite redemption also accepts a server-derived rlay_session_ bearer for a current user session.
In: header
Path Parameters
id*string
Broadcast ID
Query Parameters
status?string
Filter by delivery status
Value in
- "pending"
- "sending"
- "sent"
- "failed"
- "unknown"
- "cancelled"
cursor?string
Pagination cursor
limit?integer
Number of items per page
Range
1 <= value <= 100Default
20Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v1/broadcasts/string/recipients"{ "data": [ { "contact_id": "string", "contact_identifier": "string", "error": "string", "id": "string", "message_id": "string", "sent_at": "2019-08-24T14:15:22Z", "status": "pending" } ], "has_more": true, "next_cursor": "string"}Found something wrong? Help us improve this page.