Get Client Information by ID
GET /public/v1/users/{id}
Path Variables
| Name | Type | Required | Rule | Description |
|---|---|---|---|---|
| id | string | Mandatory | length 8 | the unique ID of client |
Query Parameters
| Key | Type | Required | Rule | Description |
|---|---|---|---|---|
| owner | boolean | Optional | true/false | default is false, whether return owner information |
| participants | boolean | Optional | true/false | default is false, whether return participant information |
Expected HTTP status code
- 200
Response
| Name | Type | Description |
|---|---|---|
| id | string | user unique id in CRM |
| name | string | user's name |
string | user's email | |
| phone | object | user's phone object |
| phone.country_code | string | user's phone country code |
| phone.number | string | user's phone number |
| type | string | user's type |
| created_at | string | create time of a user |
| referral_code | string | referral code of a user |
| owner | object | user's owner object |
| owner.id | string | owner's id |
| owner.name | string | owner's name |
| owner.email | string | owner's email |
| participants[] | array | participants' details objects |
| participants[].id | string | participants' id |
| participants[].name | string | participants' name |
| participants[].email | string | participants' email |
| trading_accounts[] | array | user's trading accounts |
| trading_accounts[].platform | string | trading account's platform: mt4, mt5 |
| trading_accounts[].connection_id | string | trading account's server connection ID |
| trading_accounts[].trading_id | string | trading account's login |
Error
| Code | Type | Description |
|---|---|---|
400 | user_not_found | Cannot find user from user_id |