v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14191644620.9 KB

Searches for phone numbers that can be ordered. For US numbers, provide at least one of the following search filters: <code>AreaCode</code>, <code>City</code>, <code>State</code>, or <code>TollFreePrefix</code>. If you provide <code>City</code>, you must also provide <code>State</code>. Numbers outside the US only support the <code>PhoneNumberType</code> filter, which you must use.

get/search#type=phone-numbers

Query parameters

area-codestring

The area code used to filter results. Only applies to the US.

citystring

The city used to filter results. Only applies to the US.

countrystring

The country used to filter results. Defaults to the US Format: ISO 3166-1 alpha-2.

statestring

The state used to filter results. Required only if you provide <code>City</code>. Only applies to the US.

toll-free-prefixstring

The toll-free prefix that you use to filter results. Only applies to the US.

phone-number-type'Local' | 'TollFree'

The phone number type used to filter results. Required for non-US numbers.

max-resultsinteger

The maximum number of results to return in a single call.

next-tokenstring

The token used to retrieve the next page of results.

MaxResultsstring

Pagination limit

NextTokenstring

Pagination token

type'phone-numbers' required

Response

Success

E164PhoneNumbersE164PhoneNumber[]

List of phone numbers, in E.164 format.

NextTokenstring

The token used to retrieve the next page of search results.