Skip to main content
GET
Search available numbers to buy

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Headers

X-Test-Mode
enum<string>

Sandbox opt-in for Clerk-session-authenticated requests. Set to true to route the call through the test-mode pipeline: no real provider delivery, no credits deducted, response meta.test_mode: true. Ignored for live API keys (dv_live_sk_*) — server-to-server clients must use a test-prefixed key (dv_test_sk_*) to exercise sandbox. Test-prefixed keys unconditionally enable sandbox regardless of this header.

Available options:
true,
false

Query Parameters

country
string

ISO 3166-1 alpha-2 country code to search (defaults to US).

type
string

Line type — one of local | mobile | toll_free.

capabilities
string

Comma-separated required capabilities — any of sms | mms | voice | fax (e.g. sms,voice).

contains
string

Digit/vanity pattern the number must contain (matched per pattern_type).

pattern_type
string

How contains matches — contains (default) | starts_with | ends_with.

area_code
string

NPA / national destination code to restrict to (2–5 digits).

locality
string

City / locality name to restrict to (free text).

rate_center
string

US rate center (exchange/wire-center) name to restrict to, e.g. SAN FRANCISCO (Bandwidth/Telnyx local-number-selection parity). US/CA only.

lata
string

US LATA code (Local Access and Transport Area), 3-5 digits, e.g. 132 for New York Metro. Resolved from each candidate's NANP area code. US only.

near_lat_lng
string

Twilio-parity geo proximity — restrict to numbers whose NPA centroid is within distance miles of this point. Format <lat>,<lng>, e.g. 37.7749,-122.4194. US/CA only.

near_postal_code
string

Twilio-parity geo proximity via US ZIP code — resolved to its 3-digit prefix centroid. When both near_lat_lng and near_postal_code are supplied, near_lat_lng wins.

distance
string

Search radius in miles for near_lat_lng / near_postal_code (default 25, clamped to 1-500).

sms_two_way
string

true to return only numbers that can both send AND receive SMS.

page
string

1-based page number (default 1).

limit
string

Results per page (default 20).

Response

Paginated available-number candidates with compliance preflight.

Paginated available-number candidates with compliance preflight.

data
object
meta
object