Skip to main content
GET
Search Available Numbers

Authorizations

Authorization
string
header
required

Your API key sent as a Bearer credential — Authorization: Bearer <api_key>, where <api_key> starts with oi_sk_ (create one via POST /v1/api-keys). Although the field is labelled 'token', paste your API key here. A dashboard JWT is also accepted on this header for the same endpoints.

Query Parameters

country
string
default:US
Required string length: 2
area_code
string | null

Area code (US/CA)

contains
string | null

Digits/letters to match

limit
integer
default:20
Required range: 1 <= x <= 50

Response

Successful Response

items
AvailablePhoneNumber · object[]
required