# `bird whatsapp list`

## Usage

```bash
bird whatsapp list [flags]
```

## Description

List WhatsApp messages, newest first, as a cursor page ({data, next_cursor, …}). Pass next_cursor back as starting_after to fetch the next page. Filter by status, contact phone number, bsuid, or tag. Use whatsapp_get for one message's current state.

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

## Examples

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

## Options

#### Filters

| Name                 | Description                                                                                                                                                                                           |
| -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `--bsuid`            | Filter by business-scoped user ID (Meta identifier).                                                                                                                                                  |
| `--created-after`    | Return only resources created at or after this timestamp (inclusive lower bound). Combine with created_before to filter to a time window. RFC 3339 / ISO 8601 with timezone.                          |
| `--created-before`   | Return only resources created strictly before this timestamp (exclusive upper bound). Combine with created_after to filter to a time window. RFC 3339 / ISO 8601 with timezone.                       |
| `--phone-number`     | Filter by contact phone number (E.164 exact match).                                                                                                                                                   |
| `--response-schema`  | Print the fields this command returns, then exit                                                                                                                                                      |
| `--status <v1,v2,…>` | Filter by status. Repeat the parameter to match any of several statuses.                                                                                                                              |
| `--tag <v1,v2,…>`    | Filter by tag. Accepts name to match any message carrying that tag name, or name:value to match a specific tag pair (e.g. category:welcome). Repeat the parameter to AND-combine several tag filters. |

#### 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 whatsapp get`](/docs/cli/reference/whatsapp-get)                 | Get a WhatsApp message                             |
| [`bird whatsapp list-events`](/docs/cli/reference/whatsapp-list-events) | List events for a WhatsApp message                 |
| [`bird whatsapp send`](/docs/cli/reference/whatsapp-send)               | Send a WhatsApp template message to one recipient. |