This s a documentation page for our shiny new REST API - you weren't meant to find it. This API isn't ready for public use yet. We're chopping and changing it a LOT as we grow it. So if you build something that uses it then it's very likely to break in a future update. Don't say you weren't warned!
URL: | https://api.kashflow.com/v2/settings/referral |
Method(s): | get |
Response Formats: | JSON, XML |
Description: | This method allows you to retrieve list of user’s referral settings. |
Response elements
| Name | Type | Description |
|---|---|---|
| AddReferralCodeToAllOutCommunications | Boolean | Whether user wants to add his referral code to all his outbound communications |
| RegistrationLink | string | Registration link containing user’s referral code. When this link is clicked user is navigated to KashFlow registration page and promocode is auto filled. |
GET Operation
Returns list of referral settings for user.To get list of referral settings –
URL : /settings/referral
Example response for GET of list of user referral settings
{
"AddReferralCodeToAllOutCommunications": true,
"RegistrationLink": "http://kf.cm/1FypF8O"
}