v52

OpenAPI 3.1.0raw.githubusercontent.com2026-07-311,1941,9384.1 MB

Phone Number Search

List available phone numbers

get/available_phone_numbers

Query parameters

administrative_areastring

Find numbers in a particular US state or CA province.

best_effortboolean

Filter to determine if best effort results should be included. Only available in USA/CANADA.

country_codestring

Filter phone numbers by country.

exclude_held_numbersboolean

Filter to exclude phone numbers that are currently on hold/reserved for your account.

featuresstring[]

Filter phone numbers with specific features.

limitinteger

Limits the number of results.

localitystring

Filter phone numbers by city.

national_destination_codestring

Filter by the national destination code of the number.

phone_number_type'local' | 'toll_free' | 'mobile' | 'national' | 'shared_cost'

Filter phone numbers by number type.

quickshipboolean

Filter to exclude phone numbers that need additional time after to purchase to activate. Only applicable for +1 toll_free numbers.

rate_centerstring

Filter phone numbers by rate center. This filter is only applicable to USA and Canada numbers.

reservableboolean

Filter to ensure only numbers that can be reserved are included in the results.

Consolidated filter parameter (deepObject style). Originally: filter[phone_number], filter[locality], filter[administrative_area], filter[country_code], filter[national_destination_code], filter[rate_center], filter[phone_number_type], filter[features], filter[limit], filter[best_effort], filter[quickship], filter[reservable], filter[exclude_held_numbers]

Response

Successful response with a list of available phone numbers.

Example response

{
  "data": [
    {
      "best_effort": false,
      "cost_information": {
        "currency": "USD",
        "monthly_cost": "6.54",
        "upfront_cost": "3.21"
      },
      "features": [
        {
          "name": "sms"
        },
        {
          "name": "voice"
        }
      ],
      "phone_number": "+19705555098",
      "quickship": true,
      "record_type": "available_phone_number",
      "region_information": [
        {
          "region_name": "US",
          "region_type": "country_code"
        }
      ],
      "reservable": true,
      "vanity_format": ""
    }
  ],
  "meta": {
    "best_effort_results": 50,
    "total_results": 100
  },
  "metadata": {
    "best_effort_results": 50,
    "total_results": 100
  }
}