# `bird amb suppressions list`

## Usage

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

## Description

Returns a paginated list of the workspace's active Apple Messages for Business suppressions: customers who have opted out of one brand, or of the whole workspace. Episodes that have ended are left out; fetch one by ID to read it. Filter by `business_id` to see one brand's suppressions, including the workspace-wide ones that block it too.

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

## Examples

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

## Options

#### Filters

| Name                | Description                                                                                                                                                           |
| ------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `--business-id`     | Keep only suppressions for this brand, including the workspace-wide ones that block it too. Omit to see suppressions for every brand in the workspace.                |
| `--handle`          | Prefix filter on the suppressed phone number or opaque identifier (case-insensitive). A complete value returns only that handle; a partial value returns every match. |
| `--handle-type`     | Keep only suppressions of this kind. Possible values: phone\_number, opaque\_user\_id.                                                                                |
| `--reason`          | Keep only suppressions with this reason. Known values: manual, opted\_out (others may exist).                                                                         |
| `--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 amb suppressions create`](/docs/cli/reference/amb-suppressions-create) | Create an Apple Messages for Business suppression |
| [`bird amb suppressions delete`](/docs/cli/reference/amb-suppressions-delete) | End an Apple Messages for Business suppression    |
| [`bird amb suppressions get`](/docs/cli/reference/amb-suppressions-get)       | Get an Apple Messages for Business 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)