Skip to main content
GET
/
v1
/
phone-numbers
/
available
Search available phone numbers
curl --request GET \
  --url https://api.zavu.dev/v1/phone-numbers/available \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "phoneNumber": "+15551234567",
      "capabilities": {
        "sms": true,
        "voice": true,
        "mms": true
      },
      "pricing": {
        "monthlyPrice": 123,
        "upfrontPrice": 123,
        "isFreeEligible": true
      },
      "friendlyName": "(555) 123-4567",
      "locality": "San Francisco",
      "region": "CA"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
countryCode
string
required

Two-letter ISO country code.

Required string length: 2
​
type
enum<string>

Type of phone number to search for.

Available options:
local,
mobile,
tollFree
​
contains
string

Search for numbers containing this string.

Maximum string length: 20
​
limit
integer
default:10

Maximum number of results to return.

Required range: x <= 50

Response

List of available phone numbers.

​
items
object[]
required