Skip to main content
GET
List Phone Numbers
Read only
Recommended. This endpoint is part of the public /v1 API reference and is the supported path for new integrations. See the migration guide for versioning guidance.
Returns every phone number provisioned in your workspace, paginated. Each entry includes the E.164 phone_number, the country_code, the type (local, toll-free, or mobile), the display nickname, the inbound_agent_id currently routing incoming calls on this number, and the purchase timestamp. Use this to power a number management view, audit which numbers are in use, or sync your DialNexa number portfolio with an internal inventory.

When to use this

  • Number management UIs: render a table of every number with status, type, and assigned agent.
  • Routing audits: confirm every active number has an agent assigned, or surface unrouted numbers as a follow-up task.
  • Cost reporting: aggregate by country_code or type to attribute telephony spend per workspace, region, or use case.
  • Operational scripts: enumerate numbers before auditing routing assignments or provisioning additional numbers.

Query parameters

Errors

  • 403 Forbidden is returned when the API key cannot read phone number records.

Authorizations

Authorization
string
header
required

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

Query Parameters

limit
number
Example:

20

page
number
Example:

1

Response

Phone numbers returned successfully.

items
object[]
total
number
page
number
limit
number