GET
/broadcasts/{id}/recipientsList recipients of a broadcast
Lists recipients of a broadcast filtered by recipient event type, such as opened, clicked, or bounced. Use type to select the event and optionally use email, bounce_type, or cursor parameters to narrow the results.
idstringrequired
The UUID of the broadcast whose recipients to retrieve.
typestringrequired
The recipient event type to filter by: sent, delivered, opened, clicked, bounced, complained, unsubscribed, or suppressed.
emailstringoptional
Filter recipients to email addresses containing this value.
bounce_typestringoptional
Filter bounced recipients by bounce type: permanent, transient, or undetermined. Use only when `type` is `bounced`.
limitintegeroptional
The number of recipients to return. Must be between 1 and 100.
afterstringoptional
Return recipients after this pagination cursor.
beforestringoptional
Return recipients before this pagination cursor.
200Returns a recipient results object with a `data` array and a `has_more` value indicating whether additional results are available.
objectstringoptional
Type of the response object.
has_morebooleanoptional
Indicates if there are more results available.
dataarray<object>optional
Array containing broadcast recipients.
Error handling
The id path parameter must be a valid UUID, and type must be one of: sent, delivered, opened, clicked, bounced, complained, unsubscribed, or suppressed. bounce_type is valid only when type is bounced, and limit must be between 1 and 100.