List Account Phone Numbers
Returns a list of phone numbers that have been purchased and assigned to your account.
API Endpoint
GET
https://api.vobiz.ai/api/v1/account/{auth_id}/numbersAuthentication 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 |
|---|---|---|
page | integer | Page number for pagination. Default: 1. |
per_page | integer | Items per page. Default: 25. Maximum: 100. |
include_subaccounts | boolean | Include 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/{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
Note: Only phone numbers with a populated auth_id field are returned. Numbers in inventory (with empty auth_id) are not included.