Skip to main content
GET
/
api
/
v1
/
account
/
{auth_id}
/
numbers
List phone numbers
curl --request GET \
  --url https://api.vobiz.ai/api/v1/account/{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": "+919876543210",
      "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:38.796024Z",
      "is_blocked": false,
      "created_at": "2026-03-25T18:30:00Z",
      "updated_at": "2026-03-25T06:58:54.752187Z",
      "is_trial_number": false,
      "last_billing_date": "2026-03-25T06:58:38.796024Z",
      "next_billing_date": "2026-04-25T06:58:38.796024Z",
      "minimum_commitment_months": 0,
      "aadhaar_verification_required": false,
      "aadhaar_verified": false,
      "source": "purchased"
    },
    {
      "id": "11223344-5566-7788-99aa-bbccddeeff00",
      "account_id": "MA_XXXXXXXX",
      "e164": "+912271263984",
      "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-03-25T10:25:30.672202Z",
      "is_blocked": false,
      "created_at": "2026-03-25T09:30:04.541115Z",
      "updated_at": "2026-03-25T10:29:35.330503Z",
      "is_trial_number": false,
      "last_billing_date": "2026-03-25T10:25:30.672202Z",
      "next_billing_date": "2026-04-25T10:25:30.672202Z",
      "minimum_commitment_months": 0,
      "aadhaar_verification_required": false,
      "aadhaar_verified": false,
      "source": "purchased"
    }
  ],
  "page": 1,
  "per_page": 25,
  "total": 24
}

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.

GET https://api.vobiz.ai/api/v1/account/{auth_id}/numbers
Returns a list of phone numbers purchased and assigned to your account.
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
pageintegerNoPage number for pagination. Default: 1.
per_pageintegerNoItems per page. Default: 25. Maximum: 100.
include_subaccountsbooleanNoInclude numbers from sub-accounts. Default: true for master accounts (MA_). When true, includes all numbers from sub-accounts under the master account.
Master Accounts (MA_): For master accounts, setting include_subaccounts=true fetches the sub-account list from the Account Service and includes all numbers from SA_ accounts in a single query.

​
Request

cURL
curl -X GET "https://api.vobiz.ai/api/v1/account/{auth_id}/numbers" \
  -H "X-Auth-ID: {auth_id}" \
  -H "X-Auth-Token: {auth_token}"

​
Response Example

Success Response (200 OK)
{
  "items": [
    {
      "id": "90be0b9e-521d-41da-aebd-aba05006272f",
      "auth_id": "{auth_id}",
      "e164": "+918071387149",
      "country": "IN",
      "region": "Karnataka",
      "capabilities": {
        "voice": false,
        "sms": false,
        "mms": false,
        "fax": false
      },
      "status": "active",
      "trunk_group_id": null,
      "setup_fee": 100,
      "monthly_fee": 500,
      "currency": "INR",
      "purchased_at": "2025-10-22T05:04:09.705084Z",
      "created_at": "2025-10-21T12:03:44.837733Z",
      "updated_at": "2025-10-22T05:04:09.705084Z"
    }
  ],
  "page": 1,
  "per_page": 25,
  "total": 1
}
Response Structure:
  • items: Array of phone number objects purchased by your account
  • page: Current page number
  • per_page: Number of items per page
  • total: Total count of purchased phone numbers
Only phone numbers with a populated auth_id are returned. Numbers in inventory (with an empty auth_id) are not included.

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

​
limit
integer
default:20
​
offset
integer
default:0

Response

200 - application/json

List of phone numbers

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