TelephonyPhone Numbers

Search Available Phone Numbers

Search carrier inventory for phone numbers available to purchase. Currently restricted to the US (country=US); pass area_code to narrow to a specific NPA. The returned numbers are not held; a subsequent POST /v1/agents/phone-numbers/purchase against the same E.164 may fail with 4xx if the number has been taken in the meantime.

Authentication

AuthorizationBearer

Enter your API key with the Bearer prefix, e.g. ‘Bearer sk_…’.

Query parameters

countrystringOptionalDefaults to US

ISO-3166 alpha-2 country code. Defaults to “US”; only “US” is supported in v1.

area_codestringOptional

Three-digit NPA to filter inventory to a region.

limitintegerOptionalDefaults to 20
Max results to return. Capped at 50.

Response

Available numbers (may be empty if no inventory matches).

numberslist of objects

Available numbers (may be empty if no inventory matches).

Errors

400
Bad Request Error
401
Unauthorized Error
503
Service Unavailable Error