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/
import requests

url = "https://api.example.com/v1/phone-numbers/"

response = requests.get(url)

print(response.text)
const options = {method: 'GET'};

fetch('https://api.example.com/v1/phone-numbers/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v1/phone-numbers/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.example.com/v1/phone-numbers/"

req, _ := http.NewRequest("GET", url, nil)

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.example.com/v1/phone-numbers/")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/phone-numbers/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
{
  "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>"
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}
{
"error": "<string>",
"message": "<string>"
}

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