Available Phone Numbers

List Available Phone Numbers

Get a list of available phone numbers

get/v4/phone-numbers/available

Request

  • Base URL: https://api.phone.com
  • URL: https://api.phone.com/v4/phone-numbers/available
  • Auth: HTTP bearer

Query parameters

offsetinteger

The number of items to skip before starting to collect the result set

limitinteger

The number of items to return

sort[id]'asc' | 'desc'

Sort response

filters[city]string

City filter

filters[country]string

Country filter (code like "US" or "CA")

filters[country_code]string

Country Code filter (like "1" or "972")

filters[is_toll_free]string

Toll free filter (1 for toll free numbers only, 0 for local numbers only)

filters[npa]string

NANP NPA filter (+1-NPA-nxx-xxxx)

filters[nxx]string

NANP NXX filter (+1-npa-NXX-xxxx)

filters[phone_number]string

Phone Number filter. You can also provide value as "contains:1234" (numbers with "1234" will be returned)

filters[price]string

Price filter. You can provide the exact price in cents or use operators like "lte:", "gte:", "lt:", "gt:", "between:".

filters[province]string

State or Province (code like "NY", "CA" or "TX")

filters[xxxx]string

NANP XXXX filter (+1-npa-nxx-XXXX)

filters[description]string

Phrase for AI-based numbers search

filters[tf_pc]string

Percent of Toll free numbers in the output (0-100). Requires "npa" or "description" filters to be defined.

mode'brief' | 'full'

Defines mode of the data output (brief or full)

Response

OK

filtersobject
sortobject
totalinteger
limitinteger
offsetinteger
itemsobject[]

Changes

No operation changes recorded.