v1

latestOpenAPI 3.1.12026-07-2682224.4 KB

List sub-users

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.

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

Query parameters

limitinteger

Maximum number of items to return per page. Default: 30

pageinteger

Requested page number (1-based). Default: 1

sort_bystring

Field to sort by: 'id', 'user_name', 'status', 'created_at', 'use_key', 'usage_cap', 'data_used', 'ip_usage_cap', 'ip_used'. Default: id

order_bystring

Sort order: desc or asc. Default: desc

keywordstring

Keyword to search within the user_name field.

Response

Successful response

successboolean

Indicates whether the request was successful.

messagestring

Human-readable response message.