Vobiz Logo|API Docs
Console ↗

List All Subaccounts

GEThttps://api.vobiz.ai/api/v1/accounts/{account_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

NameTypeDescription
page
integerPage number for pagination. Defaults to 1.
size
integerNumber of results per page. Defaults to 25.
active_only
booleanFilter 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/{account_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",
      "description": "Support-facing voice workload",
      "permissions": {
        "calls": true,
        "cdr": true
      },
      "rate_limit": 500,
      "id": "SA_67401KW8",
      "parent_account_id": "{Auth_ID}",
      "auth_id": "inG9oUky5uFjdUECaQNzeyVYD6ommaJd",
      "is_active": true,
      "created_at": "2025-10-22T03:57:35.997500Z",
      "updated_at": "2025-10-22T03:57:35.997500Z",
      "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
Delete a Subaccount
Applications