Skip to main content
GET
Get Available Phone Numbers

Authorizations

X-API-KEY
string
header
required

Your API key for authentication.

x-org-id
string
header
required

Org impersonation via x-org-id. Superadmins may impersonate any org; admins may impersonate their direct sub-organizations. Enter the target organization ID to act as that org.

Query Parameters

contains
string | null
default:""

Optional string that if present must be at least 2 characters and only contain *, 0-9, a-z, and A-Z

show_toll_free
boolean
default:false
area_code
string
default:""
exclude_all_address_required
boolean
default:true
in_postal_code
string
default:""
in_region
string
default:""
carrier
string
default:twilio

Carrier to search: twilio or telnyx

country_code
string
default:US

Country to search in. Only US or CA supported.

Response

Successful Response

phone_numbers
SinglePhoneNumberResponse · object[]
required