--- title: "bird whatsapp broadcasts list" description: "List WhatsApp broadcasts" canonical: "https://bird.com/docs/cli/reference/whatsapp-broadcasts-list" --- # `bird whatsapp broadcasts list` ## Usage ```bash bird whatsapp broadcasts list [flags] ``` ## Description List the workspace's broadcasts, newest first, filtered by status, template, number or audience. Read one with `bird whatsapp broadcasts get` for its delivery counters and failure. Returns a paginated JSON envelope; narrow with the filters below and page with --limit and --starting-after. ## Examples ```bash bird whatsapp broadcasts list bird whatsapp broadcasts list | jq -r '.data[].id' bird whatsapp broadcasts list --limit 50 --starting-after ``` ## Options #### Filters | Name | Description | | ------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--audience-id` | Filter by audience. Only broadcasts that use this audience are returned. | | `--created-after` | Limits the response to resources created at or after this timestamp. Combine it with created\_before to select a time window. Use an RFC 3339 timestamp with a timezone offset. | | `--created-before` | Limits the response to resources created before this timestamp. Combine it with created\_after to select a time window. Use an RFC 3339 timestamp with a timezone offset. | | `--from` | Filter by sending number, in E.164 format. Only broadcasts that send from this number are returned. | | `--q` | Case-insensitive literal substring match against the broadcast's name, its tags, or the referenced template's name. Percent signs, underscores, and backslashes are literal characters. | | `--response-schema` | Print the fields this command returns, then exit | | `--status …` | Filter by lifecycle status. Repeat the parameter to match more than one status, for example ?status=accepted&status=sending. Possible values: draft, scheduled, accepted, sending, sent, canceling, canceled, failed. | | `--tag` | Filter by tag. Pass name to match any broadcast that has that tag name, or pass name:value to match a specific tag pair, for example campaign:spring\_launch. | | `--template-id` | Filter by template. Only broadcasts that send this template are returned. | #### Pagination | Name | Description | | ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--ending-before` | Cursor from the prev\_cursor or refresh\_cursor field of a previous list response. Returns items immediately before the cursor position in the current sort order. prev\_cursor returns the preceding page. refresh\_cursor anchors at the first row of that response, which on a newest-first sort is how to fetch the items that have appeared since. | | `--limit ` | Maximum number of items to return per page. Allowed range: 1 to 100. | | `--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 whatsapp broadcasts cancel`](/docs/cli/reference/whatsapp-broadcasts-cancel) | Cancel a WhatsApp broadcast | | [`bird whatsapp broadcasts counts`](/docs/cli/reference/whatsapp-broadcasts-counts) | Get a WhatsApp broadcast's audience counts | | [`bird whatsapp broadcasts create`](/docs/cli/reference/whatsapp-broadcasts-create) | Create a WhatsApp broadcast | | [`bird whatsapp broadcasts delete`](/docs/cli/reference/whatsapp-broadcasts-delete) | Delete a WhatsApp broadcast | | [`bird whatsapp broadcasts get`](/docs/cli/reference/whatsapp-broadcasts-get) | Get a WhatsApp broadcast | | [`bird whatsapp broadcasts list-recipients`](/docs/cli/reference/whatsapp-broadcasts-list-recipients) | List recipients of a WhatsApp broadcast | | [`bird whatsapp broadcasts preview`](/docs/cli/reference/whatsapp-broadcasts-preview) | Render a WhatsApp broadcast's message | | [`bird whatsapp broadcasts pricing-estimate`](/docs/cli/reference/whatsapp-broadcasts-pricing-estimate) | Estimate the cost of a WhatsApp broadcast | | [`bird whatsapp broadcasts send`](/docs/cli/reference/whatsapp-broadcasts-send) | Send a WhatsApp broadcast | | [`bird whatsapp broadcasts send-quota`](/docs/cli/reference/whatsapp-broadcasts-send-quota) | Get the messaging limit for a WhatsApp broadcast | | [`bird whatsapp broadcasts test`](/docs/cli/reference/whatsapp-broadcasts-test) | Send a WhatsApp broadcast's previewed message to one number | | [`bird whatsapp broadcasts update`](/docs/cli/reference/whatsapp-broadcasts-update) | Update a draft or scheduled WhatsApp broadcast | | [`bird whatsapp broadcasts validate`](/docs/cli/reference/whatsapp-broadcasts-validate) | Check whether a WhatsApp broadcast can send | ## Related resources - [Should I use a Bird SDK or call the API directly?](/explained/platform/should-i-use-an-sdk-or-call-the-api-directly) (answer) - [Build your first integration](/learn/paths/integration) (course) - [Send your first email](/docs/get-started/send-your-first-email) (docs) [Get an implementation brief](/learn/workspace?topic=api-basics)