List referrals
GET {{baseUrl}}/v1/applications/:applicationId/campaigns/:campaignId/referrals/no_total?pageSize=1000&skip=10&sort=value&code=value&createdBefore=2022-11-08T00:11:22.082Z&createdAfter=2022-11-08T00:11:22.082Z&valid=expired&usable=false&advocate=value
List all referrals of the specified campaign.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
pageSize | number | The number of items in this response. | |
skip | number | The number of items to skip when paging through large result sets. | |
sort | string | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with -. |
Note: This parameter works only with numeric fields.
|
| code | string | | Filter results performing case-insensitive matching against the referral code. Both the code and the query are folded to remove all non-alpha-numeric characters. |
| createdBefore | string | | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. |
| createdAfter | string | | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. |
| valid | string | | Either "expired", "validNow", or "validFuture". The first option matches referrals in which the expiration date is set and in the past. The second matches referrals in which start date is null or in the past and expiration date is null or in the future, the third matches referrals in which start date is set and in the future.
|
| usable | boolean | | Either "true" or "false". If "true", only referrals where usageCounter < usageLimit will be returned, "false" will return only referrals where usageCounter >= usageLimit.
|
| advocate | string | | Filter results by match with a profile id specified in the referral's AdvocateProfileIntegrationId field |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |