List All Subaccounts
GET
https://api.vobiz.ai/api/v1/accounts/{auth_id}/sub-accounts/Returns a paginated list of subaccounts sorted by creation date, with the most recently created subaccount appearing first.
Authentication Required:
- • X-Auth-ID: Your account ID (e.g., {Auth_ID})
- • X-Auth-Token: Your account Auth Token
- • Content-Type: application/json
Parameters
Request Parameters
| Parameter | Type | Description |
|---|---|---|
pageoptional | integer | Page number for pagination. Defaults to 1. |
sizeoptional | integer | Number of results per page. Defaults to 25. |
active_onlyoptional | boolean | Filter to return only active sub-accounts. Set to true to filter out inactive sub-accounts. |
Request
cURL
curl -X GET 'https://api.vobiz.ai/api/v1/accounts/{auth_id}/sub-accounts/?page=1&size=25&active_only=true' \
--header 'X-Auth-ID: {auth_id}' \
--header 'X-Auth-Token: {auth_token}'Response Example
Success Response (200 OK)
{
"sub_accounts": [
{
"name": "Support Team",
"email": "support@example.com",
"phone": "+1234567890",
"description": "Support-facing voice workload",
"permissions": {
"calls": true,
"cdr": true
},
"rate_limit": 500,
"id": "{sub_auth_id}",
"parent_auth_id": "{auth_id}",
"parent_auth_id": "{parent_auth_id}",
"auth_id": "{auth_id}",
"auth_token": "{auth_token}",
"api_id": "{api_id}",
"email_verified": true,
"enabled": true,
"is_active": true,
"created": "2025-10-22T03:57:35.997500Z",
"modified": "2025-10-22T03:57:35.997500Z",
"created_at": "2025-10-22T03:57:35.997500Z",
"updated_at": "2025-10-22T03:57:35.997500Z",
"account": "/api/v1/accounts/{auth_id}/",
"resource_uri": "/api/v1/accounts/{auth_id}/sub-accounts/{sub_auth_id}/",
"last_used": null
}
],
"total": 1,
"page": 1,
"size": 25
}Pagination: The response includes pagination metadata at the root level:
- total: Total number of sub-accounts matching the filter
- page: Current page number
- size: Number of results per page