`bird numbers list`

Usage

Code example

bird numbers list [flags]

Description

Pages the numbers allocated to the workspace, dedicated and shared alike. Narrows on country, type, prefix and capability, so one number is reached without walking every page.

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

Procedure

Step 1 of 3 of "Connect a number you hold to WhatsApp". Next: bird whatsapp numbers create.

Examples

Code example

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

Options

Filters

Name	Description
`--capabilities <value>…`	Filter by capability. Repeat the parameter to require several at once: capabilities=sms&capabilities=voice returns only numbers that support both. Known values: sms, voice (others may exist).
`--country-code`	Filter by the country a number belongs to, as an ISO 3166-1 alpha-2 code.
`--number`	Return only the number matching these digits. Give a full number with its country code, however your own records spell it: +12025550188, 12025550188, 0012025550188, and +1 202 555 0188 all resolve to the same number. Spacing and punctuation are fine once a leading + or 00 marks the country code, or when country_code names the country; a grouped spelling without either is refused rather than guessed at, and a national spelling (bare digits without the country code) matches only when country_code names the country. A short code is matched on its bare digits instead, and since the same short code can be allocated in more than one country, pass country_code alongside it to name which one. This filter narrows the list like the others rather than replacing them, so a country or capability filter still applies. To match a range of numbers rather than one, use prefix.
`--number-type`	Return only allocated numbers of this physical type after applying the country and prefix filters. Known values: mobile, local, national, short_code, short_code_fteu, toll_free (others may exist).
`--prefix`	Return only numbers that start with these digits. With country_code, the digits are national ones, matched right after the country dial code: with country_code=US, prefix=212 returns the +1 212 area-code numbers allocated to you. Leave out the dial code and any national dialing prefix such as a leading 0; short codes never match a country-anchored prefix search. Without country_code, the digits are matched from the start of each stored number, ignoring a leading +, so short codes are reachable and a full number in digits finds itself. Digits only: up to 10 of them with country_code, 15 without.
`--reference`	Return numbers with this exact reference. Matching is case-sensitive.
`--response-schema`	Print the fields this command returns, then exit
`--search`	Matches part of the number, name, or reference, ignoring case. Number matching also ignores phone formatting such as spaces, parentheses, and hyphens. Name and reference matching preserves punctuation. Characters such as percent and underscore match literally.

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. Allowed range: 1 to 100.
`--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.

Name	Description
`bird numbers get`	Get an allocated number
`bird numbers release`	Release a dedicated number
`bird numbers update`	Update an allocated number

Continue with the documentation, guides and examples for this topic.

Get an implementation brief

Related resources