# `bird whatsapp numbers list` ## Usage ```bash bird whatsapp numbers list [flags] ``` ## Description List the WhatsApp numbers the workspace can send from as a cursor page, with each number's WhatsApp state, quality rating, messaging limit and throughput. Returns a paginated JSON envelope; narrow with the filters below and page with --limit and --starting-after. ## Examples ```bash bird whatsapp numbers list bird whatsapp numbers list | jq -r '.data[].id' bird whatsapp numbers list --limit 50 --starting-after ``` ## Options #### 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 ` | Maximum number of items to return per page. | | `--order` | Sort direction. Defaults to desc, which sorts from newest to oldest or largest to smallest, depending on the selected sort field. Possible values: asc, desc. | | `--sort` | Field to sort by. Possible values: created_at. | | `--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 | | -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--phone-number` | Filter to a single number, given in E.164 format. The value is normalized before matching, so +31612340001 and +31 6 1234 0001 are the same filter. A value that cannot be normalized is matched exactly as given. A number this workspace cannot send from returns an empty page, rather than being rejected. | | `--response-schema` | Print the fields this command returns, then exit | | `--scope` | Filter by ownership tier: system for platform-managed numbers and workspace for numbers your workspace connected. Omit to return both. A system number belongs to no WhatsApp Business Account, so pairing this with waba always returns an empty page. Possible values: system, workspace. | | `--status ` | Filter by the number's WhatsApp state: the status a number in this list carries. Repeat the parameter to match any of several. A number WhatsApp has reported no state for carries pending, so pending also matches every number whose connection has not finished. failed matches every number whose connection was refused permanently. A value this vocabulary does not recognize matches nothing, rather than being rejected. Omit to return numbers in every state. Known values: awaiting_signup, banned, connected, deleted, disconnected, failed, flagged, migrated, pending, preparing, rate_limited, restricted (others may exist). | | `--waba` | Filter to a single WhatsApp Business Account by its Meta-assigned ID. Use the waba of a connected WhatsApp Business Account, or the waba on a number this list returns. A platform-managed number belongs to no WhatsApp Business Account and is never returned when this is set, so pairing it with scope=system always returns an empty page. An account this workspace does not hold returns an empty page. | ## Related | Name | Description | | ----------------------------------------------------------------------- | --------------------- | | [`bird whatsapp numbers get`](/docs/cli/reference/whatsapp-numbers-get) | Get a WhatsApp number |