Skip to main content
GET
List Users

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

offset
integer
default:0
Required range: x >= 0
limit
integer
default:50
Required range: 1 <= x <= 200
search
string | null
Maximum string length: 255
email
string | null
Maximum string length: 255
status
enum<string> | null

User status enum.

Available options:
active,
blocked,
deleted
sort_by
enum<string>
default:created_at

Sort options for users list.

Available options:
created_at,
balance,
traffic,
last_activity,
total_spent,
purchase_count

Response

Successful Response

Paginated list of users.

users
UserListItem · object[]
required
total
integer
required
offset
integer
default:0
limit
integer
default:50