bird email broadcasts list-recipients

Usage

Code example

bird email broadcasts list-recipients <broadcast-id> [flags]

List the recipients resolved for a broadcast with their per-recipient delivery state, paginated. It shows who a broadcast reached and how far each one got. The list is empty until the broadcast starts sending. Pass to to look up one address instead of paging the whole set.

Returns a paginated JSON envelope; narrow with the filters below and page with --limit and --starting-after.

Examples

Code example

bird email broadcasts list-recipients <broadcast-id>
bird email broadcasts list-recipients <broadcast-id> | jq -r '.data[].id'
bird email broadcasts list-recipients <broadcast-id> --limit 50 --starting-after <cursor>

Options

Pagination

Name	Description
--ending-before	Cursor from the prev_cursor field of a previous list response. Returns items immediately before the cursor position in the current sort order.
--limit <n>	Maximum number of items to return per page.
--starting-after	Cursor from the next_cursor field of a previous list response. Returns items immediately after the cursor position in the current sort order.

Filters

Name	Description
--response-schema	Print the fields this command returns, then exit
--to	Return only the recipient at this address. Exact match, normalised to lowercase before comparison, so it returns at most one row.

Name	Description
bird email broadcasts cancel	Cancel a broadcast
bird email broadcasts counts	Get a broadcast's audience counts
bird email broadcasts create	Create a broadcast
bird email broadcasts delete	Delete a broadcast
bird email broadcasts get	Get a broadcast
bird email broadcasts list	List broadcasts
bird email broadcasts list-clicked-links	List a broadcast's clicked links
bird email broadcasts list-events	List events for a broadcast
bird email broadcasts send	Send a broadcast
bird email broadcasts update	Update a draft or scheduled broadcast