---
title: "List sub accounts"
method: GET
path: "/client/v1/subs/get-list"
---

# List sub accounts

`GET /client/v1/subs/get-list`

Returns a list of sub accounts.

## Query parameters

- `limit` integer
- `page` integer
- `sort_by` string
- `order_by` string
- `username` string
- `status` integer
- `keyword` string

## Response `200`

Successful response.

- ResponseListSubAccount — Returns the list of sub accounts for the user.
  - `success` boolean — Indicates whether the request was successful.
  - `message` string — Response message.
  - `result` object — Response data.
    - `items` SubAccountInfo[] — Array of sub accounts.
      - `id` integer — ID of the sub account.
      - `username` string — Username of the sub account.
      - `note` string, nullable — Note for the sub account.
      - `number_of_ips` integer — Number of IPs allocated to the sub account.
      - `traffic_data` integer — Amount of traffic allocated to the sub account (in bytes).
      - `status` integer — Sub account status. 1 = Enabled 2 = Disabled
      - `created_at` integer — Timestamp when the sub account was created.
      - `setting` object
        - `auto_add_ips` integer — Enable or disable automatic IP allocation from the main account.
        - `auto_add_when_number_ips` integer — Threshold for automatically adding IPs to the sub account.
        - `number_ips_auto_add` integer — Number of IPs to automatically add when auto-add is triggered.
        - `auto_disable_at` integer, nullable — Timestamp when the sub account will be automatically disabled.
        - `auto_add_traffic` integer — Enable or disable automatic traffic allocation from the main account.
        - `auto_add_when_traffic_bellow` integer — Threshold for automatically adding traffic to the sub account.
        - `amount_traffic_auto_add` integer — Amount of traffic to automatically add when auto-add is triggered (in bytes).
        - `traffic_plan_use_auto_add` integer, nullable — ID of the traffic plan used for automatic traffic allocation.
    - `total_items` integer — Total number of items.
    - `total_pages` integer — Total number of pages.

## Other responses

- `400` — Bad request.
- `403` — Authentication error.

---

[API](https://skmtc.net/9proxy/apis/cd-key.md) · [All operations](https://skmtc.net/9proxy/apis/cd-key/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/9proxy/cd-key/versions/c159f83789a8/schema)