v52

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

Phone Number Search

List available phone number blocks

get/available_phone_number_blocks

Query parameters

country_codestring

Filter phone numbers by country.

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.

Consolidated filter parameter (deepObject style). Originally: filter[locality], filter[country_code], filter[national_destination_code], filter[phone_number_type]

Response

Successful response with a list of available phone numbers blocks.

Example response

{
  "data": [
    {
      "cost_information": {
        "currency": "USD",
        "monthly_cost": "6.54",
        "upfront_cost": "3.21"
      },
      "features": [
        {
          "name": "sms"
        },
        {
          "name": "voice"
        }
      ],
      "phone_number": "+19705555000",
      "range": 10,
      "record_type": "available_phone_number_block",
      "region_information": [
        {
          "region_name": "US",
          "region_type": "country_code"
        }
      ]
    }
  ],
  "meta": {
    "best_effort_results": 50,
    "total_results": 100
  }
}