Broadcasts
List broadcast recipients
Resend-compatible: recipients of a broadcast for one event type (sent, delivered, opened, clicked, bounced, complained, unsubscribed, suppressed), newest first, with after/before cursors. Each has contact_id; opened and clicked add count, clicked adds clicked_links, bounced adds bounce_type. Without type, every recipient (not in Resend). Requires the email:read scope.
get/v1/broadcasts/{id}/recipients
Request
- Base URL: https://smtpfa.st/api
- URL: https://smtpfa.st/api/v1/broadcasts/{id}/recipients
- Auth: HTTP bearer
Path parameters
idstring required
The broadcast ID
Query parameters
type'sent' | 'delivered' | 'opened' | 'clicked' | 'bounced' | 'complained' | 'unsubscribed' | 'suppressed'
bounce_type'permanent' | 'transient' | 'undetermined'
With type=bounced only
emailstring
Recipients whose address contains this text
limitinteger
afterstring
Return recipients after this recipient ID
beforestring
Return recipients before this recipient ID
Response
Recipients
object required
Changes
No recorded changes to this operation across all 1 revision of this API.