Skip to content

feat: add broadcasts/{id}/recipients endpoint - #97

Merged
dielduarte merged 1 commit into
mainfrom
feat/broadcasts-recipients-spec
Aug 21, 2026
Merged

feat: add broadcasts/{id}/recipients endpoint#97
dielduarte merged 1 commit into
mainfrom
feat/broadcasts-recipients-spec

Conversation

@dielduarte

Copy link
Copy Markdown
Contributor

Summary

  • Documents GET /broadcasts/{id}/recipients, matching the current public-api handler (apps/public-api/src/routes/broadcasts/recipients.ts)
  • Query params: type (required, event-type enum), email, bounce_type (valid only with type=bounced), plus standard cursor pagination
  • Response items: id (opaque pagination cursor), contact_id (nullable), email, count (opened/clicked only), bounce_type (bounced only), clicked_links (clicked only)

Tracked by DEV-1869.

Note: the endpoint is currently gated behind the headless-dashboard feature flag in public-api — worth confirming that gate is lifted before/alongside this going live in docs.

Test plan

  • yq -o=json resend.yaml parses cleanly
  • redocly lint — 0 new errors (10 pre-existing, unrelated to this change); 1 warning (missing 4XX response), consistent with every other endpoint in this spec

@dielduarte
dielduarte marked this pull request as ready for review August 21, 2026 19:59
Comment thread resend.yaml
object:
type: string
description: Type of the response object.
example: list

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder if we should be more explicit here when the value is a constant. Here it's always "list", right?

@dielduarte dielduarte Aug 21, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah by convention its always list, but something we can improve for sure. would help with code gen/docs later

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants