Skip to main content
GET
/
api
/
v1
/
Account
/
{auth_id}
/
inventory
/
numbers
List Inventory Numbers
curl --request GET \
  --url https://api.vobiz.ai/api/v1/Account/{auth_id}/inventory/numbers \
  --header 'X-Auth-ID: <api-key>' \
  --header 'X-Auth-Token: <api-key>'
import requests

url = "https://api.vobiz.ai/api/v1/Account/{auth_id}/inventory/numbers"

headers = {
    "X-Auth-ID": "<api-key>",
    "X-Auth-Token": "<api-key>"
}

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

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

fetch('https://api.vobiz.ai/api/v1/Account/{auth_id}/inventory/numbers', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "items": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "e164": "+14155551234",
      "country": "US",
      "region": "CA",
      "status": "active",
      "setup_fee": 0,
      "monthly_fee": 1,
      "currency": "INR",
      "created_at": "2025-01-15T10:00:00Z",
      "updated_at": "2025-01-15T10:00:00Z"
    }
  ],
  "page": 1,
  "per_page": 25,
  "total": 500
}
This endpoint lists phone numbers in inventory (auth_id is null) that are available for purchase. Use the Purchase from Inventory endpoint to assign them to your account.
Only numbers with status='active' and auth_id=NULL are returned. These numbers are ready to be purchased and assigned to your account.

​
HTTP Request

GET /api/v1/Account/{auth_id}/inventory/numbers
Authentication required:
  • X-Auth-ID - Your Auth ID (e.g., {auth_id})
  • X-Auth-Token - Your account Auth Token
  • Content-Type: application/json

​
Query Parameters

FieldTypeRequiredDescription
countrystringNoFilter by country code (e.g., US, IN).
searchstringNoSubstring match against the E.164 number. For example, search=80 matches +918065....
excludestringNoOne or more E.164 prefixes to remove from results. Include the country code (e.g. 9180 for India +91 80-series, 1415 for US +1 415). A leading + is optional (+9180 also works). Accepts repeated params (?exclude=9180&exclude=9192) or a comma-separated list (?exclude=9180,9192); both forms can be combined.
pageintegerNoPage number for pagination. Default: 1.
per_pageintegerNoItems per page. Default: 25. Maximum: 100.
How exclude behaves:
  • The prefix is matched against the number’s full E.164 form (+<countrycode><rest>), so exclude=9180 removes every number starting with +9180. It works for any country — it is not limited to Indian numbers.
  • Include the country code. exclude=9180 (not exclude=80). A bare series like 80 matches +80*, which does not exist for Indian inventory, so it has no effect.
  • It is ANDed with every other filter, so it takes priority over search. A number that matches search but also matches an excluded prefix is still excluded (?search=80&exclude=9180 returns no +9180* numbers).
  • Duplicate values are de-duplicated silently.
  • The total in the response reflects the filtered result set.
There is no separate /numbers/search endpoint. To find numbers available to rent, use this endpoint with the country and search filters.

​
Response

Returns a paginated list of phone numbers available in inventory.
Response - 200 OK
{
  "items": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "e164": "+14155551234",
      "country": "US",
      "region": "CA",
      "status": "active",
      "setup_fee": 0.0,
      "monthly_fee": 1.0,
      "currency": "INR",
      "created_at": "2025-01-15T10:00:00Z",
      "updated_at": "2025-01-15T10:00:00Z"
    }
  ],
  "page": 1,
  "per_page": 25,
  "total": 500
}

​
Examples

​
cURL - List All Inventory Numbers

cURL Request
curl -X GET "https://api.vobiz.ai/api/v1/Account/{auth_id}/inventory/numbers?page=1&per_page=25" \
  -H "X-Auth-ID: {auth_id}" \
  -H "X-Auth-Token: {auth_token}"

​
cURL - Filter by Country

cURL Request
curl -X GET "https://api.vobiz.ai/api/v1/Account/{auth_id}/inventory/numbers?country=US&page=1&per_page=25" \
  -H "X-Auth-ID: {auth_id}" \
  -H "X-Auth-Token: {auth_token}"

​
cURL - Search by prefix within a country

cURL Request
curl -X GET "https://api.vobiz.ai/api/v1/Account/{auth_id}/inventory/numbers?country=IN&search=80&page=1&per_page=25" \
  -H "X-Auth-ID: {auth_id}" \
  -H "X-Auth-Token: {auth_token}"

​
cURL - Exclude one or more series

Remove numbers whose prefix you don’t want. Include the country code (9180, not 80); a leading + is optional.
cURL Request
# Exclude the India 80-series — no +9180* numbers are returned
curl -X GET "https://api.vobiz.ai/api/v1/Account/{auth_id}/inventory/numbers?exclude=9180&per_page=50" \
  -H "X-Auth-ID: {auth_id}" \
  -H "X-Auth-Token: {auth_token}"

# Exclude multiple prefixes (comma-separated; ?exclude=9180&exclude=9192 is equivalent)
curl -X GET "https://api.vobiz.ai/api/v1/Account/{auth_id}/inventory/numbers?exclude=9180,9192&per_page=50" \
  -H "X-Auth-ID: {auth_id}" \
  -H "X-Auth-Token: {auth_token}"

# Works for any country — exclude a US prefix (+1 415)
curl -X GET "https://api.vobiz.ai/api/v1/Account/{auth_id}/inventory/numbers?exclude=1415&per_page=50" \
  -H "X-Auth-ID: {auth_id}" \
  -H "X-Auth-Token: {auth_token}"
Each item carries a capabilities object (voice, sms, mms, fax). Vobiz numbers are voice-first, so sms, mms, and fax are commonly false. Inspect setup_fee and monthly_fee (in the listed currency) before purchasing — these are the amounts that will be debited.
Use Cases:
  • Browse available numbers before purchasing
  • Check inventory for specific countries or regions
  • View pricing information for available numbers
  • Find numbers with specific capabilities (voice, SMS, MMS)
Next Step: Once you find a number you want, use the Purchase from Inventory endpoint to assign it to your account.

Authorizations

​
X-Auth-ID
string
header
required

Your Vobiz account Auth ID

​
X-Auth-Token
string
header
required

Your Vobiz account Auth Token

Path Parameters

​
auth_id
string
required

Your account Auth ID

Example:

"MA_XXXXXX"

Query Parameters

​
country
string

Filter by country code (e.g., "US", "IN").

Example:

"IN"

​
search
string

Substring match against the E.164 number (e.g., "80" matches "+918065...").

​
exclude
string

One or more E.164 prefixes to remove from results. Include the country code (e.g. "9180" for India +91 80-series, "1415" for US +1 415); a leading "+" is optional. Matched against the full E.164 form, so it works for any country. Accepts a comma-separated list ("9180,9192") or repeated params ("exclude=9180&exclude=9192"), and the two forms can be combined. It is ANDed with all other filters, so it takes priority over search; duplicates are de-duplicated silently and total reflects the filtered result set.

Example:

"9180,9192"

​
page
integer
default:1
​
per_page
integer
default:25
Required range: x <= 100

Response

200 - application/json

Inventory numbers

​
items
object[]
required
​
page
integer
required
​
per_page
integer
required
​
total
integer
required