Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

JWT Bearer token obtained from authentication. Pass as: Authorization: Bearer

Query Parameters

countryCode
string
default:US

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

Pattern: ^[A-Za-z]{2}$
numberType
enum<string>

Phone number type to search for (treated as local when omitted)

Available options:
local,
mobile,
national,
toll_free,
shared_cost
areaCode
string

Filter results to a specific area code

capabilities
enum<string>[]

Required capabilities for the phone numbers

Maximum array length: 50

Communication capability type

Available options:
sms,
mms,
voice
limit
integer
default:10

Maximum number of results to return

Required range: 1 <= x <= 50

Response

200 - application/json

OK

Search results for available phone numbers

items
object[]
required

Array of available phone numbers matching the search criteria