Skip to main content
GET
List phone numbers

Authorizations

X-API-KEY
string
header
required

Query Parameters

limit
integer
default:20

Maximum rows to return.

Required range: 0 <= x <= 100
offset
integer
default:0

Number of rows to skip.

Required range: x >= 0
status
enum<string>

Filter by lifecycle status. When omitted, archived numbers are excluded; pass archived to see them.

Available options:
pending_verification,
provisioning,
active,
failed,
archived
source
enum<string>

Filter by registration source.

Available options:
managed,
byo_trunk,
hosted

Response

Paginated list of phone numbers. shared_caller_id is the caller ID presented for the shared "Platform default" number (null when unset).