GET /public/v1/users

Query Parameters

Key	Type	Required	Rule	Description
skip	number	Mandatory	minimum 0	the number of the records that is skipping from the full list
limit	number	Mandatory	minimum 0 maximum 500	the number of records each page will show
type	string	Optional	ib/trader	type of the user requested
suspended	boolean	Optional	true/false	default is false, switch between suspended and unsuspended users
owner	boolean	Optional	true/false	default is false, whether return owner information
tags	boolean	Optional	true/false	default is false, whether return system tags and custom tags

Expected HTTP status code

• 200

Response

Name	Type	Description
count	number	total number of the list
records	array	list of users in array
records[].id	string	user unique id in CRM
records[].name	string	user's name
records[].email	string	user's email
records[].phone	object	user's phone object
records[].phone.country_code	string	user's phone country code
records[].phone.number	string	user's phone number
records[].type	string	user's type
records[].group_id	string	user's CRM group id
records[].group_name	object	user's CRM group name (localized)
records[].referral_code	string	user's custom referral code
records[].kyc_status	string	user's kyc status: pending, verified, rejected
records[].kyc_processing	boolean	whether user has submitted kyc profile
records[].trading_accounts[]	array	user's trading accounts
records[].trading_accounts[].platform	string	trading account's platform: mt4, mt5
records[].trading_accounts[].connection_id	string	trading account's server connection ID
records[].trading_accounts[].trading_id	string	trading account's login
records[].referrer_id	string	user's referrer's ID
records[].referrer_name	string	user's referrer's name
records[].owner	object	user's owner details
records[].owner.id	string	owner's ID
records[].owner.name	string	owner's name
records[].owner.email	string	owner's email
records[].downlines_count	number	user's number of downlines
records[].system_tags[]	array	system tags: is_open, is_deposit, is_trade, is_prop_trading
records[].custom_tags[]	array	custom tags
records[].custom_tags[].id	string	tag ID
records[].custom_tags[].name	string	tag name
records[].custom_tags[].color	string	tag color
records[].last_login_time	string	last login time
records[].created_at	string	create time of a user
records[].updated_at	string	update time of a user

Previous pageAuthentication V2

Next pageGet Client Information