numbers

List available phone numbers

Returns phone numbers available for purchase in a country. Narrow the search with number_type, capabilities, and prefix. Inventory numbers come first and support pagination. The final page can include a live snapshot of numbers available from suppliers.

Inventory results are newest first by default. When you specify number_type and the suppliers on sale in the market are ranked into multiple priority tiers, results follow supplier priority, newest first within each tier. These searches reject ending_before and return neither prev_cursor nor refresh_cursor, so backward and refresh paging are unavailable. Country-only searches and markets with a single tier keep newest-first inventory ordering and support backward and refresh paging.

get/v1/numbers/available

Request

  • Base URL: https://us1.platform.bird.com
  • URL: https://us1.platform.bird.com/v1/numbers/available
  • Auth: one of:
    • HTTP bearer
    • API key in cookie bird_session

Query parameters

country_codestring required

ISO 3166-1 alpha-2 country code to search in.

number_typestring

Physical type of a phone number. New number types may be added over time, so treat unrecognized values as supported types rather than errors.

Return only numbers of this physical type after applying the country and prefix filters.

prefixstring

Return only numbers that start with these digits, matched right after the country dial code: with country_code=US, prefix=212 matches +1 212 area-code numbers and prefix=833 matches 833 toll-free numbers. Digits only. Leave out the country dial code and any national dialing prefix such as a leading 0. Short codes never match a prefix search.

capabilitiesstring[]

Filter by capability. Repeat the parameter to require several at once: capabilities=sms&capabilities=voice returns only numbers that support both.

limitinteger

Maximum number of items to return per page.

starting_afterstring

Cursor from the next_cursor field of a previous list response. Returns items immediately after the cursor position in the current sort order.

ending_beforestring

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.

Headers

X-Workspace-Idstring

Workspace context for the request. Required for dashboard authentication and master keys. Workspace keys and access tokens already identify their workspace; send that workspace or omit the header. A different one is rejected.

X-Organization-Idstring

Organization context for the request. Required for dashboard authentication. An API key or access token carries its own organization, so send either that organization or no header at all; a different one is rejected.

Response

List of available phone numbers.

next_cursorstring nullable required

Cursor for the next page. Pass back as starting_after to advance forward. null when no next page exists.

prev_cursorstring nullable required

Cursor for the previous page. Pass back as ending_before to step backward. null when no previous page exists.

refresh_cursorstring nullable required

Refresh anchor, the first row of this response. Pass back as ending_before to fetch what precedes it in the current sort order. On a newest-first sort those are the items that have appeared since; on any other sort they are the items that sort earlier, so refreshing such a list means re-fetching it instead. Non-null whenever data is non-empty; null only on an empty page. Distinct from prev_cursor.

Example response

{
  "data": [
    {
      "country_code": "US",
      "pricing": {
        "setup_price": {
          "amount": "0.00995",
          "currency_code": "EUR"
        },
        "recurring_price": {
          "amount": "0.00995",
          "currency_code": "EUR"
        },
        "recurring_period": {
          "unit": "month",
          "count": 3
        },
        "intervals_per_charge": 12
      }
    }
  ],
  "next_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE0OjAzOjEwWlwiIiwiaSI6IjAxOTJmM2IxLTRjN2UtN2EyYi05ZDYxLThmM2E1YzJlN2I0MCJ9",
  "refresh_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE2OjQyOjAxWlwiIiwiaSI6IjAxOTJmM2IxLTllMDQtN2NkMy1iODE3LTJhNmY0ZDFjOGUwOSJ9"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.