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>'
{
  "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
    }
  ]
}

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
string

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[]