Appearance
Get Referrals Link By ID
About 207 wordsLess than 1 minute
GET /public/v1/referrals/links/{id}/user
Path Variables
| Name | Type | Required | Rule | Description |
|---|---|---|---|---|
| id | string | Mandatory | length 8 | the unique ID of Referrals Link |
Expected HTTP status code
- 200
Response
| Name | Type | Description |
|---|---|---|
| id | string | unique link id in CRM |
| name | map | referrals link's name |
| type | string | referrals link's type |
| user_group | string | which group's user can use this link |
| trading_platform | string | default trading platform for this link only on type is ***_to_trader |
| connection_id | string | default connection_id for this link only on type is ***_to_trader |
| trading_group | string | default trading_group for this link only on type is ***_to_trader |
| account_type_id | string | default account_type_id for this link only on type is ***_to_trader |
| offer_uuid | string | default offer_uuid for this link only on type is ***_to_trader |
| owner_id | string | default owner_id for this link |
| backup_owner_id | string | backup owner_id for this link |
| participants | array | default participants for this link |
| origin | string | default origin for user |
| remove_referrers | array | who can't use this referrals link |
| remove_referrer_groups | array | which groups can't user this referrals link |
| description | map | description |
| initial_amount | string | initial amount when referrals link's type is demo_account |
Error
| Code | Type | Description |
|---|---|---|
400 | link_not_found | Cannot find Referrals link from link_id |