---
title: "bird whatsapp broadcasts list-recipients"
description: "List recipients of a WhatsApp broadcast"
canonical: "https://bird.com/docs/cli/reference/whatsapp-broadcasts-list-recipients"
---

# `bird whatsapp broadcasts list-recipients`

## Usage

```bash
bird whatsapp broadcasts list-recipients <broadcast-id> [flags]
```

## Description

List each recipient's delivery status, with `rejection_reason` on a rejected one and `message_id` to read the message itself. Filter by phone number with `to`. The list is empty until the broadcast starts sending.

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

## Examples

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

## Options

#### 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 <n>`      | 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.                                                                                                                                                                                                          |

#### Filters

| Name                | Description                                                                                                          |
| ------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `--response-schema` | Print the fields this command returns, then exit                                                                     |
| `--to`              | Return only this recipient, a phone number in E.164 format or a business-scoped user ID. It matches at most one row. |

## 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`](/docs/cli/reference/whatsapp-broadcasts-list)                         | List WhatsApp broadcasts                                    |
| [`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)