Skip to main content
GET
Search available phone numbers

Authorizations

Authorization
string
header
required

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

Query Parameters

countryCode
string
required

Two-letter ISO country code.

Required string length: 2
type
enum<string>

Type of phone number to search for.

Available options:
local,
national,
tollFree
contains
string

Search for numbers containing this string.

Maximum string length: 20
capabilities
string

Comma-separated capabilities the number must have: sms, voice, mms. Numbers missing any of them are dropped.

Example:

"voice,sms"

limit
integer
default:10

Maximum number of results to return.

Required range: x <= 50

Response

List of available phone numbers.

items
object[]
required