Skip to main content
GET
List your phone numbers

Authorizations

Authorization
string
header
required

Use a Bearer token to access these API endpoints. Example: "Bearer {your-token}"

Query Parameters

page
integer
default:1
per_page
integer
default:25
Required range: x <= 100
status
enum<string>
Available options:
active,
pending,
inactive
country_code
string
Example:

"US"

type
enum<string>
Available options:
local,
toll_free,
mobile,
national
compliance
enum<string>
Available options:
completed,
requirement_pending

Free-text search on number or country

bound_to_agent_uuid
string<uuid>

Filter to numbers bound to a specific agent on any channel

sort
enum<string>
default:created_at
Available options:
created_at,
monthly_fee,
number
only_include
enum<string>

Filter the result to a single source. Omit to get both. purchased = owned inventory only. external = registered trunks only.

Available options:
purchased,
external

Response

Success

success
boolean

Indicates whether the request completed successfully. True for successful responses; false for documented error responses.

message
string

Human-readable response message. Safe to display in logs or simple client notifications; use structured fields for program logic.

data
object