# `bird whatsapp suppressions list`

## Usage

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

## Description

List the workspace's recorded WhatsApp suppression addresses as a cursor page.

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

## Examples

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

## Options

#### Filters

| Name                | Description                                                                                                                  |
| ------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
| `--address`         | Address prefix filter (case-insensitive). A complete address returns only that address; a partial value returns all matches. |
| `--reason`          | Return only suppressions with this reason: - manual: Added through the API or dashboard. Possible values: manual.            |
| `--response-schema` | Print the fields this command returns, then exit                                                                             |

#### 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.                                                                                                                                                                                                                                                                                                             |
| `--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 suppressions add`](/docs/cli/reference/whatsapp-suppressions-add)       | Create a WhatsApp suppression |
| [`bird whatsapp suppressions get`](/docs/cli/reference/whatsapp-suppressions-get)       | Get a WhatsApp suppression    |
| [`bird whatsapp suppressions remove`](/docs/cli/reference/whatsapp-suppressions-remove) | End a WhatsApp suppression    |

## 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)