Skip to main content
GET
/
api
/
v1
/
partner
/
accounts
/
{customer_auth_id}
/
numbers
List customer numbers
curl --request GET \
  --url https://api.vobiz.ai/api/v1/partner/accounts/{customer_auth_id}/numbers \
  --header 'X-Auth-ID: <api-key>' \
  --header 'X-Auth-Token: <api-key>'
{
  "items": [
    {
      "id": "aabbccdd-1234-5678-90ab-cdef12345678",
      "account_id": "MA_XXXXXXXX",
      "e164": "+918012345678",
      "country": "IN",
      "region": "Karnataka",
      "capabilities": {
        "voice": true,
        "sms": false,
        "mms": false,
        "fax": false
      },
      "status": "active",
      "provider": "",
      "setup_fee": 100,
      "monthly_fee": 300,
      "currency": "INR",
      "application_id": "20577609616603585",
      "voice_enabled": true,
      "tags": [],
      "purchased_at": "2026-03-25T06:58:38Z",
      "is_blocked": false,
      "created_at": "2025-03-31T18:30:00Z",
      "updated_at": "2026-03-25T06:58:54Z",
      "is_trial_number": false,
      "last_billing_date": "2026-03-25T06:58:38Z",
      "next_billing_date": "2026-04-25T06:58:38Z",
      "minimum_commitment_months": 0,
      "aadhaar_verification_required": false,
      "aadhaar_verified": false,
      "source": "purchased"
    },
    {
      "id": "11223344-1234-5678-90ab-cdef12345678",
      "account_id": "MA_XXXXXXXX",
      "e164": "+919876543210",
      "country": "IN",
      "region": "Mumbai",
      "capabilities": {
        "voice": true,
        "sms": false,
        "mms": false,
        "fax": false
      },
      "status": "active",
      "provider": "",
      "setup_fee": 100,
      "monthly_fee": 200,
      "currency": "INR",
      "application_id": "31985999331899218",
      "voice_enabled": true,
      "tags": [],
      "purchased_at": "2026-02-17T10:25:30Z",
      "is_blocked": false,
      "created_at": "2026-02-14T09:30:04Z",
      "updated_at": "2026-02-17T10:29:35Z",
      "is_trial_number": false,
      "last_billing_date": "2026-02-17T10:25:30Z",
      "next_billing_date": "2026-03-17T10:25:30Z",
      "minimum_commitment_months": 0,
      "aadhaar_verification_required": false,
      "aadhaar_verified": false,
      "source": "purchased"
    }
  ],
  "page": 1,
  "per_page": 20,
  "total": 2,
  "account_auth_id": "MA_XXXXXXXX"
}

Documentation Index

Fetch the complete documentation index at: https://docs.vobiz.ai/llms.txt

Use this file to discover all available pages before exploring further.

← Partner API Reference View and monitor the DID (Direct Inward Dialing) phone number inventory assigned to each customer, or get a global view across all accounts. Customers need at least one active DID to receive inbound calls.
All Partner API requests use X-Auth-ID and X-Auth-Token headers. See Authentication for details.

​
Overview

These endpoints are read-only. They show you what numbers are assigned to each customer. To assign or release numbers, use the Vobiz Console or contact your account manager.
Read-only inventory. The Partner API does not currently support assigning, purchasing, or releasing phone numbers programmatically. Use the Vobiz Partner Console to manage number inventory, or contact support@vobiz.ai for bulk number provisioning.

​
Customer Numbers

Returns all phone numbers assigned to a specific customer account. Use to verify a customer’s number inventory, check allocation status, and identify the application each number is routed to.

​
Query Parameters

ParameterDefaultDescription
page1Page number (1-indexed)
per_page20Items per page (max 100)
search-Filter by partial number match
curl -X GET \
  "https://api.vobiz.ai/api/v1/partner/accounts/{customer_auth_id}/numbers?page=1&per_page=20" \
  -H "X-Auth-ID: {your_partner_id}" \
  -H "X-Auth-Token: {your_auth_token}" \
  -H "Accept: application/json"

curl -X GET \
  "https://api.vobiz.ai/api/v1/partner/accounts/{customer_auth_id}/numbers?search=9122712" \
  -H "X-Auth-ID: {your_partner_id}" \
  -H "X-Auth-Token: {your_auth_token}" \
  -H "Accept: application/json"

{
  "items": [],
  "page": 1,
  "per_page": 20,
  "total": 0,
  "account_auth_id": "MA_XXXXXXXX"
}

​
All Numbers (Global)

Returns all phone numbers across every customer account under your partner umbrella. Use to audit your complete DID inventory, identify unassigned numbers, or find numbers that are expiring soon. 
curl -X GET \
  "https://api.vobiz.ai/api/v1/partner/numbers?page=1&per_page=50" \
  -H "X-Auth-ID: {your_partner_id}" \
  -H "X-Auth-Token: {your_auth_token}" \
  -H "Accept: application/json"

{
  "items": [],
  "page": 1,
  "per_page": 50,
  "total": 0,
  "account_auth_id": "MA_XXXXXXXX"
}

​
Number Management Guide

  • Every customer needs at least one active number - A customer with no assigned numbers cannot receive inbound calls. After creating a customer account, assign at least one DID via the Vobiz Console.
  • Monitor expiry dates - Numbers with an expires_at value will stop routing calls if not renewed. Build a scheduled check that queries the numbers endpoint weekly and flags any numbers with expires_at within 14 days.
  • Verify application routing after number assignment - After assigning a number, verify that application_id is set correctly. A number with a null application_id will receive calls but have nowhere to route them, resulting in immediate hangups for callers.
  • Track costs for billing - The monthly_cost field gives the DID rental cost per number. Add this to your customer invoice alongside their call usage from the CDR endpoint.

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

​
customer_auth_id
string
required

Query Parameters

​
search
string

Substring match against the E.164 number.

​
page
integer
default:1
​
per_page
integer
default:20

Response

200 - application/json

Customer numbers

​
items
array
required
​
page
integer
required
​
per_page
integer
required
​
total
integer
required
​
account_auth_id
string
required