User

Get Users

Get all users

get/api/users

Query parameters

offsetinteger nullable
limitinteger nullable
idsinteger[] nullable
usernamestring[] nullable
usernamesstring[] nullable
adminstring[] nullable
admin_idsinteger[] nullable
groupinteger[] nullable
searchstring nullable
'active' | 'disabled' | 'limited' | 'expired' | 'on_hold'
OR
UserStatus[]
sortstring nullable
proxy_idstring nullable
'no_reset' | 'day' | 'week' | 'month' | 'year'
OR
DataLimitResetStrategy[]
data_limit_mininteger nullable
data_limit_maxinteger nullable
expire_afterstring date-time nullable
Example:2026-01-01T00:00:00+03:30
expire_beforestring date-time nullable
Example:2026-01-31T23:59:59+03:30
online_afterstring date-time nullable
Example:2026-01-01T00:00:00+03:30
online_beforestring date-time nullable
Example:2026-01-31T23:59:59+03:30
onlineboolean
no_data_limitboolean
no_expireboolean
load_subboolean

Response

Successful Response

totalinteger required

Changes

No recorded changes to this endpoint across all 1 revision of this API.