Skip to main content
GET
List Phone Numbers

Headers

x-api-key
string | null

Your API key for programmatic access. Send it in the x-api-key header; you can create and manage keys from the Developers page.

Query Parameters

provider
enum<string> | null

Filter by telephony provider

Available options:
twilio,
sip_trunk,
exotel
agent_id
string | null

Filter by assigned agent ID

branch_id
string | null

Filter by assigned branch ID

Response

Successful Response

phone_number
string
required

Phone number

label
string
required

Label for the phone number

phone_number_id
string
required

The ID of the phone number

assigned_agent
PhoneNumberAgentInfo · object | null

The agent that is assigned to the phone number

Example:
provider
string
default:twilio

Phone provider

Allowed value: "twilio"