Search Available Phone Numbers

POST

/phone-numbers/search

• Production
• QA

Numbers a carrier has available to buy. Buy one with POST /phone-numbers/purchase.

Authorizations

• BearerAuth

Parameters

Header Parameters

X-Target-Org-Id

Any of:

string

string

null

null

Request Body ^required

object

area_code

Any of:

string

string

null

null

country

ISO country code.

string

default: US

locality

Any of:

string

string

null

null

match

Where pattern must appear: first, anywhere or last.

string

default: first

number_type

local or toll_free.

string

default: local

pattern

Any of:

string

string

null

null

provider

required

The carrier to search - the same values POST /phone-numbers/purchase takes.

string

Responses

200

Successful Response

object

data

required

Numbers available to buy, under items.

object

items

Array

key

additional properties

any

pagination

Any of:

PaginationMeta

object

has_next

required

Whether there are more pages

boolean

limit

required

Items per page

integer

next_cursor

Any of:

string

string

null

null

notes

Any of:

Array<string>

Array<string>

null

null

page

required

Current page number (1-indexed)

integer

total

required

Total number of items

integer

total_available

Any of:

integer

integer

null

null

total_is_lower_bound

Any of:

boolean

boolean

null

null

null

null

422

Validation Error

object

detail

Array<object>

object

loc

required

Array

msg

required

string

type

required

string