---
title: "List sub-users"
method: GET
path: "/client/v1/user-passes/get-list"
---

# List sub-users

`GET /client/v1/user-passes/get-list`

Returns a paginated list of sub-users for the authenticated account, with support for keyword search by user_name, as well as sorting and ordering.

## Query parameters

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

## Response `200`

Successful response

- ResponseListSubUser — Sub-users list response payload.
  - `success` boolean — Indicates whether the request was successful.
  - `message` string — Human-readable response message.
  - `result` object — Paginated response data.
    - `items` SubUser[] — List of sub-users.
      - `id` integer — Sub-user ID.
      - `user_name` string — Sub-user username.
      - `use_key` string — Password used with user_name for authentication.
      - `usage_cap` integer — Traffic usage cap for the sub-user (bytes).
      - `ip_usage_cap` integer — IP usage cap for the sub-user.
      - `data_used` integer — Total traffic consumed by the sub-user.
      - `ip_used` integer — Total number of IPs consumed by the sub-user.
      - `status` integer — 1: Active, 2: Disabled, 3: Blocked
      - `note` string — Optional note associated with the sub-user.
      - `created_at` integer — Sub-user creation timestamp.
      - `updated_at` integer — Sub-user last updated timestamp.
    - `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)