Skip to main content
GET
Get Toll-Free Inventory

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

state
string

State Abbreviation (e.g., CA, MS, AL..)

Maximum string length: 2
tnMask
string
required

Phone number mask (e.g., xxxxx88xxx)

Maximum string length: 11
quantity
string
required

Number of results

Pattern: ^[1-9]\d*$

Response

200 - application/json

Available toll-free numbers

results
string[]
required

Available phone numbers