bird amb suppressions list
Usage
Code example
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
Code example
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 | Create an Apple Messages for Business suppression |
| bird amb suppressions delete | End an Apple Messages for Business suppression |
| bird amb suppressions get | Get an Apple Messages for Business suppression |
Related resources
Continue with the documentation, guides and examples for this topic. Resources are in English.
Understand the conceptShould I use a Bird SDK or call the API directly?Follow the learning pathBuild your first integrationImplementation guideSend your first email
Get an implementation brief