---
title: "List of Sub-Accounts"
method: POST
path: "/api/v4/sub-account/list"
tags: ["Sub-Account"]
---

# List of Sub-Accounts

`POST /api/v4/sub-account/list`

The endpoint returns list of current user [sub-accounts](/glossary#sub-account).

<Warning>
Rate limit: 1000 requests/10 sec.
</Warning>

<Note>
The API does not cache the response.
</Note>

## Request body

- object
  - `search` string — Search term
  - `limit` integer
  - `offset` integer

## Response `200`

Successful response

- object
  - `offset` integer
  - `limit` integer
  - `data` SubAccount[]
    - `id` string — Sub-account identifier
    - `alias` string — Sub-account alias/name
    - `userId` string — User identifier associated with account
    - `email` string — Sub-account email (masked)
    - `status` string — Sub-account status
    - `color` string — Sub-account color
    - `kyc` object — KYC information
      - `shareKyc` boolean — Whether KYC is shared with main account
      - `kycStatus` string — KYC status
    - `permissions` object — Sub-account permissions
      - `spotEnabled` boolean — Spot trading enabled
      - `collateralEnabled` boolean — Collateral trading enabled

## Other responses

- `400` — Request validation failed

---

[API](https://skmtc.net/whitebit/apis/whitebit-private-http-api-v4.md) · [All operations](https://skmtc.net/whitebit/apis/whitebit-private-http-api-v4/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/whitebit/whitebit-private-http-api-v4/revisions/76c9def9942f/schema)
