Skip to main content
GET
Search available numbers

Authorizations

Authorization
string
header
required

Use Authorization: Bearer pyai_live_... (or pyai_test_...).

Query Parameters

country
enum<string>
default:US

ISO-2 country to search in.

Available options:
US,
CA,
IN
area_code
string

3-digit US or Canada area code (NPA).

Pattern: ^[2-9][0-9]{2}$
contains
string

Digit pattern the number should contain.

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

Response

Available numbers

object
string
Example:

"list"

data
object[]
provisioning
object