TAtalon
Referrals

List referrals

[!note] Management API endpoints are not meant to be used in real-time integrations that directly serve your end users. Rate limit: 3 requests per second.

List all referrals of the specified campaign.

get/v1/applications/{applicationId}/campaigns/{campaignId}/referrals/no_total

Request

Path parameters

applicationIdinteger required

The ID of the Application. It is displayed in your Talon.One deployment URL.

campaignIdinteger required

The ID of the campaign. It is displayed in your Talon.One deployment URL.

Query parameters

pageSizeinteger

The number of items in the response.

skipinteger

The number of items to skip when paging through large result sets.

sortstring

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: You may not be able to use all fields for sorting. This is due to performance limitations.

codestring

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.

createdBeforestring date-time

Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.

createdAfterstring date-time

Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.

valid'expired' | 'validNow' | 'validFuture'

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'true' | 'false'

Either "true" or "false". If "true", only referrals where usageCounter < usageLimit will be returned, "false" will return only referrals where usageCounter >= usageLimit.

advocatestring

Filter results by match with a profile ID specified in the referral's AdvocateProfileIntegrationId field.

Response

OK

hasMoreboolean required

Example response

{
  "hasMore": true,
  "data": [
    {
      "id": 6,
      "created": "2020-06-10T09:05:27.993483Z",
      "startDate": "2020-11-10T23:00:00Z",
      "expiryDate": "2021-11-10T23:00:00Z",
      "usageLimit": 1,
      "campaignId": 78,
      "advocateProfileIntegrationId": "URNGV8294NV",
      "friendProfileIntegrationId": "BZGGC2454PA",
      "attributes": {
        "channel": "web"
      },
      "importId": 4,
      "code": "27G47Y54VH9L",
      "usageCounter": 1,
      "batchId": "tqyrgahe"
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.