Users

User management and related operations

circle-info

This document uses the REST API. For more details, see the Working with the REST API page.

List Users

get
/users

Retrieves a list of users on the platform.

Query parameters
pageintegerOptional

Page number for pagination

limitintegerOptional

Number of items per page

Responses
chevron-right
200

Successful operation

application/json
get
/users

Get User

get
/users/{id}

Retrieves a specific user by ID.

Path parameters
idintegerRequired
Responses
chevron-right
200

Successful operation

application/json
idintegerOptionalExample: 1
operator_idstringOptionalExample: 1122334455667788900
namestringOptionalExample: John Doe
first_namestringOptionalExample: John
last_namestringOptionalExample: Doe
loginstringOptionalExample: johndoe
emailstringOptionalExample: [email protected]
email_verified_atstring · date-timeOptional
phonestringOptionalExample: +1234567890
phone_verified_atstring · date-timeOptional
account_codestringOptionalExample: AB1234
genderstring · enumOptionalPossible values:
langstringOptionalExample: en
nationalitystringOptionalExample: US
cnistringOptionalExample: 1234567890
addressstringOptionalExample: 123 Main St
citystringOptionalExample: New York
countrystringOptionalExample: US
birthdaystring · dateOptional
levelintegerOptional
vipbooleanOptionalDefault: false
ultra_vipbooleanOptionalDefault: false
is_testbooleanOptionalDefault: false
activebooleanOptionalDefault: true
hiddenbooleanOptionalDefault: false
blockedbooleanOptionalDefault: false
self_excludedbooleanOptionalDefault: false
self_exclusion_datestring · date-timeOptional
created_atstring · date-timeOptional
updated_atstring · date-timeOptional
get
/users/{id}

List User Wallets

get
/users/{id}/wallets

Retrieves a list of wallets for a specific user.

Path parameters
idintegerRequired
Query parameters
pageintegerOptional

Page number for pagination

limitintegerOptional

Number of items per page

Responses
chevron-right
200

Successful operation

application/json
get
/users/{id}/wallets

Get User Wallet

get
/users/{userId}/wallets/{walletId}

Retrieves a specific wallet for a user.

Path parameters
userIdintegerRequired
walletIdintegerRequired
Responses
chevron-right
200

Successful operation

application/json
idintegerOptionalExample: 1
user_idintegerOptionalExample: 1
user_operator_idstringOptionalExample: 1122334455667788900
user_operator_sessionstringOptionalExample: 54cabae3-577f-41e9-bef0-dfc396e7088b
user_loginstringOptionalExample: johndoe
currencystringOptionalExample: USD
balancenumberOptionalExample: 100
balance_versionintegerOptionalExample: 1
winnumberOptionalExample: 40
win_versionintegerOptionalExample: 3
depositnumberOptionalExample: 60
deposit_versionintegerOptionalExample: 2
bonusnumberOptionalExample: 0
bonus_versionintegerOptionalExample: 1
created_atstring · date-timeOptional
updated_atstring · date-timeOptional
get
/users/{userId}/wallets/{walletId}

List User Sessions

get
/users/{id}/sessions

Retrieves a list of sessions (bets, wins, and rollbacks) for a specific user.

Path parameters
idintegerRequired
Query parameters
datestring · enumOptional

Date filter. Default "today". "custom" requires range[start] & range[end] parameters.

Possible values:
range[start]stringOptional

Date range in Y-m-d H:i format. Required if date is "custom" only.

range[end]stringOptional

Date range in Y-m-d H:i format. Required if date is "custom" only.

pageintegerOptional

Page number for pagination

limitintegerOptional

Number of items per page

Responses
chevron-right
200

Successful operation

application/json
get
/users/{id}/sessions

Last updated