Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

country
enum<string>
required

The country code for the phone number.

Available options:
US,
IN
pattern
string

3-character prefix for the phone number to search with

provider
enum<string>

The telephony provider for the phone number.

Available options:
twilio,
plivo,
vobiz

Response

list phone numbers response

region
string

Name of the geographic region associated with the phone number.

Pattern: ^[A-Za-z ]+$
Example:

"San Francisco"

friendly_name
string | null

A user-assigned friendly label for the number; may be null if not set.

Pattern: ^.*$
Example:

null

locality
string | null

Name of the locality or area; may be null if not available.

Pattern: ^.*$
Example:

null

phone_number
string

E.164 formatted phone number, including country code.

Pattern: ^\+[1-9][0-9]{7,14}$
Example:

"+19876543210"

provider
enum<string>

The telephony provider for the phone number.

Available options:
twilio,
plivo,
vobiz
price
number<float>

Price of the number in USD.

Example:

5