feat: add broadcasts.recipients() method - #261
Open
dielduarte wants to merge 1 commit into
Open
Conversation
Wraps GET /broadcasts/{id}/recipients to list a broadcast's recipients
for a given event type, with support for email/bounce_type filters
and cursor pagination.
Contributor
There was a problem hiding this comment.
No issues found across 7 files
Confidence score: 5/5
- Automated review surfaced no issues in the provided summaries.
- No files require special attention.
Requires human review: Adds new recipients and recipients_async methods to the Broadcasts module, along with supporting data models and tests for the new API endpoint.
Re-trigger cubic
dielduarte
marked this pull request as ready for review
August 22, 2026 01:54
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds
Broadcasts.recipients()/recipients_async()forGET /broadcasts/{id}/recipients.Spec: resend/resend-openapi#97
Node reference: resend/resend-node#1078
Tests: 584 passed. flake8 + mypy clean.
Summary by cubic
Adds
resend.Broadcasts.recipients()andresend.Broadcasts.recipients_async()to list a broadcast’s recipients by event type with filters and cursor pagination. Previously recipient-level delivery and engagement data was not available; now clients can query delivered, opened, clicked, bounced, and more, including counts and clicked links when applicable.RecipientsParamsandRecipientsResponse, plusBroadcastRecipient,BroadcastRecipientEventType,BroadcastRecipientBounceType, andBroadcastRecipientClickedLink(exported viaresend.__init__).type; supportsemail,bounce_type(only whentype="bounced"),limit(1–100), and cursor paramsafter/before(mutually exclusive).broadcast_idgoes in the path; other params go in the query.object="list",data: List[BroadcastRecipient], andhas_more. Optional fields:countforopened/clicked,bounce_typeforbounced, andclicked_linksforclicked.Written for commit 4abdc68. Summary will update on new commits.