List Inventory Numbers

Browse available phone numbers in inventory that are not assigned to any account.

This endpoint lists phone numbers in inventory (auth_id IS NULL) that are available for purchase. These are numbers that can be assigned to your account using the Purchase from Inventory endpoint.

Note: 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/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

Request Parameters

Name	Type	Description
`country`	string	Filter by country code (e.g., "US", "IN"). Optional.
`page`	integer	Page number for pagination. Default: 1.
`per_page`	integer	Items per page. Default: 25. Maximum: 100.

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}"

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.

List Account Phone Numbers

Purchase from Inventory