List Account Phone Numbers

Returns a list of phone numbers that have been purchased and assigned to your account.

API Endpoint
GEThttps://api.vobiz.ai/api/v1/account/{account_id}/numbers

Authentication: Requires Bearer Token (JWT). Pass your access token in the Authorization header.

Query Parameters

Request Parameters

NameTypeDescription
page
integerPage number for pagination. Default: 1.
per_page
integerItems per page. Default: 25. Maximum: 100.
include_subaccounts
booleanInclude numbers from sub-accounts. Default: true for master accounts (MA_). When true, fetches numbers from all 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.

cURL - X-Auth-ID & X-Auth-Token

cURL Request
curl -X GET "https://api.vobiz.ai/api/v1/account/YOUR_ACCOUNT_ID/numbers" \
  -H "X-Auth-ID: YOUR_AUTH_ID" \
  -H "X-Auth-Token: YOUR_AUTH_TOKEN"

Response Example

Success Response (200 OK)
{
  "items": [
    {
      "id": "90be0b9e-521d-41da-aebd-aba05006272f",
      "account_id": "{Auth_ID}",
      "e164": "+918071387149",
      "country": "IN",
      "region": "Karnataka",
      "capabilities": {
        "voice": false,
        "sms": false,
        "mms": false,
        "fax": false
      },
      "status": "active",
      "provider": "cloudconnect",
      "provider_ref": "",
      "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

Note: Only phone numbers with a populated account_id field are returned. Numbers in inventory (with empty account_id) are not included.