younifyd
Menu

Get Referrals Without Total Count

List referrals

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

Use it in a workflow

  1. Add a step and choose the Talon.One connector.
  2. Pick the Get Referrals Without Total Count action (under management).
  3. Fill in the fields below, then reference the result from later steps as {{getReferralsWithoutTotalCount.response.data}}.

Request

Path parameters

applicationIdinteger (int64)required

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

campaignIdinteger (int64)required

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

Query parameters

pageSizeinteger (int64)

The number of items in the response.

Default 1000

skipinteger (int64)

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.

validstring

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.

One ofexpiredvalidNowvalidFuture

usablestring

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

One oftruefalse

advocatestring

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

Response

Returns 200 with an object. Read it in later steps with {{getReferralsWithoutTotalCount.response.data.<field>}}.

hasMoreboolean
dataarray<object>
idinteger (int64)required

The internal ID of this entity.

createdstring (date-time)required

The time this entity was created.

startDatestring (date-time)

Timestamp at which point the referral code becomes valid.

expiryDatestring (date-time)

Expiration date of the referral code. Referral never expires if this is omitted.

usageLimitinteger (int64)required

The number of times a referral code can be used. `0` means no limit but any campaign usage limits will still apply.

campaignIdinteger (int64)required

ID of the campaign from which the referral received the referral code.

advocateProfileIntegrationIdstringrequired

The Integration ID of the Advocate's Profile.

friendProfileIntegrationIdstring

An optional Integration ID of the Friend's Profile.

attributesobject

Arbitrary properties associated with this item.

importIdinteger (int64)

The ID of the Import which created this referral.

codestringrequired

The referral code.

usageCounterinteger (int64)required

The number of times this referral code has been successfully used.

batchIdstring

The ID of the batch the referrals belong to.

json
{
  "hasMore": true,
  "data": [
    {
      "code": "27G47Y54VH9L",
      "created": {},
      "usageLimit": 1,
      "campaignId": 78,
      "usageCounter": 1,
      "batchId": "tqyrgahe",
      "advocateProfileIntegrationId": "URNGV8294NV",
      "expiryDate": {},
      "importId": 4,
      "friendProfileIntegrationId": "BZGGC2454PA",
      "attributes": {
        "channel": "web"
      },
      "id": 6,
      "startDate": {}
    }
  ]
}

Need more? See the Talon.One guide for connection setup and behaviour shared by every action.

Was this page helpful?
Get Referrals Without Total Count — Talon.One — Documentation