Phone & voice · Phone Numbers

Search available numbers

Searches available numbers.

GEThttps://api.pozy.ai/v1/phone-numbers/available

searchAvailablePhoneNumbers

Guides: Phone numbers, Buy a number, SMS

Request

Send your API key as Authorization: Bearer pz_live_.... Read-only keys can call it. Keys with the telephony resource group disabled get 403 resource_group_disabled. Authentication

Query parameters

Name	Type	Notes
`country`	string	Default `US`
`numberType`	string	One of `local`, `mobile`, `national`, `toll_free`
`areaCode`	string
`type`	string
`prefix`	string
`locality`	string
`contains`	string
`sms`	boolean
`limit`	integer	Default `20`At most 100
`masked`	boolean

Example

curl -X GET "https://api.pozy.ai/v1/phone-numbers/available?limit=20" \
  -H "Authorization: Bearer $POZY_API_KEY"

const res = await fetch("https://api.pozy.ai/v1/phone-numbers/available?limit=20", {
  headers: { Authorization: `Bearer ${process.env.POZY_API_KEY}` },
});
const data = await res.json();
if (!res.ok) throw new Error(data?.error ?? `Request failed with status ${res.status}`);
console.log(data);

import os
import requests

resp = requests.get(
    "https://api.pozy.ai/v1/phone-numbers/available",
    headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
    params={
        "limit": 20,
    },
    timeout=30,
)
resp.raise_for_status()
print(resp.json())

Response

200 on success

countrystring
numberTypestring
requireSmsboolean
numbersarray of object
8 child fields
- phoneNumberstring
- featuresarray of string
- localitystring
- bestEffortboolean
- maskedNumberstring
- numberTypestring
- claimIdstring
- claimUrlstring
maskedboolean
nearstring
Can be null.
claimIdstring
claimUrlstring

200 response

{
  "country": "US",
  "numberType": "string",
  "requireSms": true,
  "numbers": [
    {
      "phoneNumber": "+14155550123",
      "features": [
        "string"
      ],
      "locality": "string",
      "bestEffort": true,
      "maskedNumber": "string",
      "numberType": "string",
      "claimId": "64d7462a13b28690b007b884",
      "claimUrl": "https://pozy.ai/media/example-1.jpg"
    }
  ],
  "masked": true,
  "near": "string",
  "claimId": "64d7462a13b28690b007b884",
  "claimUrl": "https://pozy.ai/media/example-1.jpg"
}

Errors

Errors use one shape: { error, type, code, param?, details? }. The ones you are most likely to see here:

400	invalid_request_error	A parameter or body field is missing or invalid. `param` names it.
401	authentication_error	The API key is missing, revoked or expired.
403	permission_error	The key is scoped to other profiles or has this resource group disabled.
429	rate_limit_error	Too many requests this minute. Wait for `Retry-After` seconds.

Every code is listed in Errors.

More in Phone Numbers

GETList phone numbers GETGet phone number DELRelease phone number POSTPurchase phone number GETResolve a number claim GETList offerable number countries GETCheck country availability GETGet KYC form spec POSTSubmit KYC GETView a KYC document on file POSTUpload a KYC document POSTPre-validate KYC address POSTCreate a hosted KYC link GETList port-in orders POSTPort numbers in POSTCheck portability GETResolve a port claim POSTUpload a porting document GETCountry porting requirements GETA port-in order's pending requirements DELCancel a port-in POSTPre-review a KYC packet GETGet declined requirements POSTResubmit a declined number POSTReply to the regulatory reviewer POSTRespond to the regulatory reviewer (message + corrections)GETList stock watches POSTWatch an out-of-stock country DELStop watching a country POSTRequest the WhatsApp verification code for a number