Documentation
Sign inGet started

bird email broadcasts list-recipients

Usage

Przykład kodu
bird email broadcasts list-recipients <broadcast-id> [flags]

Description

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.
Returns a paginated JSON envelope; narrow with the filters below and page with --limit and --starting-after.

Examples

Przykład kodu
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

NameDescription
--ending-beforeCursor 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-afterCursor from the next_cursor field of a previous list response. Returns items immediately after the cursor position in the current sort order.

Filters

NameDescription
--response-schemaPrint the fields this command returns, then exit
NameDescription
bird email broadcasts cancelCancel a broadcast
bird email broadcasts countsGet a broadcast's audience counts
bird email broadcasts createCreate a broadcast
bird email broadcasts deleteDelete a broadcast
bird email broadcasts getGet a broadcast
bird email broadcasts listList broadcasts
bird email broadcasts list-eventsList events for a broadcast
bird email broadcasts sendSend a broadcast
bird email broadcasts updateUpdate a draft or scheduled broadcast