Skip to main content
GET
/
phone-numbers
/
available-phone-numbers
cURL
curl --request GET \
  --url https://api.puretalk.ai/api/phone-numbers/available-phone-numbers \
  --header 'X-API-KEY: <api-key>'
import requests

url = "https://api.puretalk.ai/api/phone-numbers/available-phone-numbers"

headers = {"X-API-KEY": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};

fetch('https://api.puretalk.ai/api/phone-numbers/available-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.puretalk.ai/api/phone-numbers/available-phone-numbers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-KEY: <api-key>"
],
]);

$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.puretalk.ai/api/phone-numbers/available-phone-numbers"

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

req.Header.Add("X-API-KEY", "<api-key>")

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.puretalk.ai/api/phone-numbers/available-phone-numbers")
.header("X-API-KEY", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.puretalk.ai/api/phone-numbers/available-phone-numbers")

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

request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "msg": "Success",
  "err": false,
  "results": [
    {
      "friendly_name": "(619) 514-3812",
      "phone_number": "+1234567890",
      "postal_code": "12345",
      "capabilities": {
        "voice": true,
        "SMS": true,
        "MMS": true
      },
      "locality": "New York",
      "region": "NY",
      "iso_country": "US",
      "monthly_fee": 2
    }
  ]
}
{
"err": true,
"msg": "An error occurred."
}
{
"detail": "Authentication credentials were not provided."
}

Authorizations

X-API-KEY
string
header
required

Authorization header containing API key. You can find your API key in the dashboard under 'API Keys'.

Query Parameters

area_code
string

Filter by United States area code

Search by phone number (supports partial matches)

region
string

Filter by United States region/state code

Response

Available phone numbers response

msg
string

A success message

Example:

"Success"

err
boolean

Indicates if there was an error

Example:

false

results
object[]