List broadcast recipients
Get recipients for a specific broadcast.
Authorizations
Bearer token authentication using your API key
Query Parameters
Only deliveries in this status.
ALL, QUEUED, SENDING, PROCESSED, SENT, FAILED, SKIPPED Only deliveries on this channel type, e.g. 'whatsapp_bot'.
Only deliveries to this contact.
Only deliveries to this email address.
Search recipients by name, email, phone or username.
Only deliveries created at or after this ISO 8601 date.
Only deliveries created at or before this ISO 8601 date.
Field to sort broadcast recipients by
created_at, updated_at Direction to sort broadcast recipients by
asc, desc Page number
Number of items to take
Next page token (Only used on special endpoints)
Response
The channel type
internal, org, agent, custom, whatsapp_bot, messenger_bot, instagram_dm, tiktok_dm, telegram_bot, slack_bot, teams_bot, gmail, outlook, twilio, telnyx, email, smpp The status of the broadcast recipient
QUEUED, SENDING, PROCESSED, SENT, FAILED, SKIPPED How the recipient was triggered (transactional only)
API, MANUAL, INBOX, IMPORT, null Schema for the contact