bird email broadcasts list
Usage
Code example
bird email broadcasts list [flags]Description
List broadcasts in the workspace, newest first. Filter by lifecycle status, audience_id, or tag, or search tag names/values with q. Use email_broadcasts_get for full detail on one broadcast.
Returns a paginated JSON envelope; narrow with the filters below and page with --limit and --starting-after.
Examples
Code example
bird email broadcasts list
bird email broadcasts list | jq -r '.data[].id'
bird email broadcasts list --limit 50 --starting-after <cursor>Options
Filters
| Name | Description |
|---|---|
| --audience-id | Filter by audience. |
| --q | Case-insensitive substring match against the broadcast's tag names and values, or the referenced template's name. |
| --response-schema | Print the fields this command returns, then exit |
| --status <v1,v2,…> | Filter by lifecycle status. Repeatable: pass the parameter more than once to match any of the given statuses (e.g. ?status=accepted&status=sending). Possible values: draft, scheduled, accepted, sending, sent, canceling, canceled, failed. |
| --tag | Filter by tag. Accepts name to match any broadcast carrying that tag name, or name:value to match a specific tag pair (e.g. campaign:spring_launch). |
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. |
Related
| 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-events | List events for a broadcast |
| bird email broadcasts list-recipients | List recipients of a broadcast |
| bird email broadcasts send | Send a broadcast |
| bird email broadcasts update | Update a draft or scheduled broadcast |