Skip to main content
GET
List Phone Numbers

Authorizations

Authorization
string
header
required

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

Query Parameters

phone_number
string | null

Exact E.164 match, e.g. +14155550123.

agent_id
string | null

Only numbers bound to this agent.

cursor
string | null
page
integer | null

1-based page number; mutually exclusive with cursor.

Required range: x >= 1
include_total
boolean
default:false
page_size
integer
default:30
Required range: 1 <= x <= 100

Response

Request fulfilled, document follows

phone_numbers
PublicPhoneNumberEntity · object[]
required
has_more
boolean
required
next_cursor
string | null
total
integer | null