Skip to main content
GET
List phone numbers

Authorizations

Authorization
string
header
required

Wavix API key. Pass as Authorization: Bearer <api_key>. Keys support per-resource scopes (none / read / write). See Restricted keys and scopes.

Query Parameters

city_id
integer<int32>

Filters numbers by the ID of their city or rate center.

Example:

123

Filters numbers by a full or partial phone number.

Example:

"256537"

label
string

Filters numbers by label.

Example:

"ALEX"

label_present
boolean

When true, returns only numbers that have a label; when false, only numbers without one.

Example:

true

page
integer<int32>

Page number to retrieve. Default 1.

Example:

2

per_page
integer<int32>

Number of records to return per page. Default 25.

Example:

50

Response

Returns a paginated list of phone numbers.

items
Number · object[]
required

List of phone numbers on the account.

doc_types
DocumentType · object[]
required

Documents required to activate phone numbers.

pagination
Pagination · object
required