Skip to main content
GET
/
v1
/
phone-numbers
Retrieve a paginated list of all phone numbers configured in your PIA Platform account
curl --request GET \
  --url https://api.example.com/v1/phone-numbers/
{
  "phone_numbers": [
    {
      "phone_number": "<string>",
      "_id": "<string>",
      "provider": "sip",
      "friendly_name": "<string>",
      "sip_termination_uri": "<string>",
      "sip_trunk_username": "<string>",
      "sip_trunk_password": "<string>",
      "inbound_agent_id": "<string>",
      "outbound_agent_id": "<string>",
      "sip_infra_region": "global"
    }
  ],
  "next_page_token": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.verbex.ai/llms.txt

Use this file to discover all available pages before exploring further.

Query Parameters

​
page_size
integer
default:20
Required range: 1 <= x <= 100
​
page_token
string | null

Response

Successful Response

​
phone_numbers
(GetSIPPhoneNumberResponse · object | GetPiaPhoneNumberResponse · object | GetTwilioPhoneNumberResponse · object)[]
required

List of phone number records matching the query parameters

​
next_page_token
string | null

Token for retrieving the next page of results. Null if there are no more results