Skip to main content
GET
/
api
/
v1
/
accounts
/
{auth_id}
/
sub-accounts
List sub-accounts
curl --request GET \
  --url https://api.vobiz.ai/api/v1/accounts/{auth_id}/sub-accounts/ \
  --header 'X-Auth-ID: <api-key>' \
  --header 'X-Auth-Token: <api-key>'
{
  "sub_accounts": [
    {
      "name": "Acme Corp",
      "email": null,
      "phone": null,
      "description": null,
      "permissions": null,
      "rate_limit": 1000,
      "id": "500001",
      "parent_account_id": "500000",
      "parent_auth_id": "MA_XXXXXXXX",
      "auth_id": "SA_XXXXXXXX",
      "auth_token": "<redacted>",
      "api_id": "aabbccdd-1234-5678-90ab-cdef12345678",
      "email_verified": false,
      "enabled": true,
      "created": "2026-03-25",
      "modified": "2026-03-25",
      "is_active": true,
      "created_at": "2026-03-25T08:33:24.700542Z",
      "updated_at": "2026-03-25T08:33:24.700542Z",
      "last_used": null,
      "account": "/v1/Account/MA_XXXXXXXX/",
      "resource_uri": "/v1/Account/MA_XXXXXXXX/Subaccount/SA_XXXXXXXX/"
    },
    {
      "name": "John Doe",
      "email": "john@example.com",
      "phone": null,
      "description": null,
      "permissions": {
        "cdr": true,
        "calls": true
      },
      "rate_limit": 5000,
      "id": "500002",
      "parent_account_id": "500000",
      "parent_auth_id": "MA_XXXXXXXX",
      "auth_id": "SA_YYYYYYYY",
      "auth_token": "<redacted>",
      "api_id": "11223344-5566-7788-99aa-bbccddeeff00",
      "email_verified": false,
      "enabled": true,
      "created": "2026-03-25",
      "modified": "2026-03-25",
      "is_active": true,
      "created_at": "2026-03-25T11:56:03.796409Z",
      "updated_at": "2026-03-25T11:56:03.796409Z",
      "last_used": null,
      "account": "/v1/Account/MA_XXXXXXXX/",
      "resource_uri": "/v1/Account/MA_XXXXXXXX/Subaccount/SA_YYYYYYYY/"
    }
  ],
  "total": 28,
  "page": 1,
  "size": 10
}

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/accounts/{auth_id}/sub-accounts/
Returns a paginated list of subaccounts sorted by creation date, most recently created first.
Authentication required:
  • X-Auth-ID - Your account Auth ID
  • X-Auth-Token - Your account Auth Token
  • Content-Type: application/json

​
Parameters

FieldTypeRequiredDescription
pageintegerNoPage number for pagination. Defaults to 1.
sizeintegerNoNumber of results per page. Defaults to 25.
active_onlybooleanNoWhen set to true, returns only active 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

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"

Response

200 - application/json

List of sub-accounts

​
sub_accounts
object[]
required
​
total
integer
required
​
page
integer
required
​
size
integer
required