v1

latestOpenAPI 3.1.12026-07-2682224.4 KB

List sub accounts

Returns a list of sub accounts.

get/client/v1/subs/get-list

Query parameters

limitinteger

Maximum number of items returned. Default: 30.

pageinteger

Page number of the requested data. Default: 1.

sort_bystring

Field used for sorting: id, username, created_at, number_of_ips. Default: id.

order_bystring

Sorting order: desc or asc. Default: desc.

usernamestring

Filter by sub account username.

statusinteger

Filter by sub account status: 1 = enabled, 2 = disabled.

keywordstring

Search sub accounts by keyword.

Response

Successful response.

successboolean

Indicates whether the request was successful.

messagestring

Response message.