---
title: "List sub-accounts"
method: GET
path: "/api/v1/accounts/{auth_id}/sub-accounts/"
tags: ["Sub-Accounts"]
---

# List sub-accounts

`GET /api/v1/accounts/{auth_id}/sub-accounts/`

## Request

- Base URL: `https://api.vobiz.ai`
- URL: `https://api.vobiz.ai/api/v1/accounts/{auth_id}/sub-accounts/`
- Auth: API key in header `X-Auth-ID` and API key in header `X-Auth-Token`
- TypeScript: <https://skmtc.dev/vobiz/apis/vobiz-api/docs/api/v1/accounts/:auth_id/sub-accounts/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieve all sub-accounts under the master account.

## Path parameters

- `auth_id` string, required

## Response `200`

List of sub-accounts

- object
  - `sub_accounts` object[], required
    - `name` string, required
    - `email` string, nullable, required
    - `phone` unknown, required
    - `description` unknown, required
    - `permissions` union, required
      - unknown
      - object
        - `cdr` boolean
        - `calls` boolean
    - `rate_limit` integer, required
    - `id` string, required
    - `parent_account_id` string, required
    - `parent_auth_id` string, required
    - `auth_id` string, required
    - `auth_token` string, required
    - `api_id` string, required
    - `email_verified` boolean, required
    - `enabled` boolean, required
    - `created` string, required
    - `modified` string, required
    - `is_active` boolean, required
    - `created_at` string, required
    - `updated_at` string, required
    - `last_used` string, nullable, required
    - `account` string, required
    - `resource_uri` string, required
  - `total` integer, required
  - `page` integer, required
  - `size` integer, required

---

[API](https://skmtc.dev/vobiz/apis/vobiz-api.md) - [All operations](https://skmtc.dev/vobiz/apis/vobiz-api/llms.txt) - [OpenAPI document](https://skmtc.dev/vobiz/apis/vobiz-api/revisions/863f08cd6737?raw)