younifyd
Menu

Referrals Code Holders

List Referral Code Holders with campaign ID

GET/v1/referrals/{campaignId}/members/{memberId}/holders

Use it in a workflow

  1. Add a step and choose the Voucherify connector.
  2. Pick the Referrals Code Holders action (under Referrals).
  3. Fill in the fields below, then reference the result from later steps as {{referralsCodeHolders.response.data}}.

Request

Path parameters

campaignIdstringrequired

Unique identifier of a referral program campaign.

memberIdstringrequired

Unique referral code or its identifier.

Query parameters

limitinteger

Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items.

orderstring

Sorts the results using one of the filtering options, where the dash `-` preceding a sorting option means sorting in a descending order.

One ofid-id

starting_after_idstring

A cursor for pagination. It retrieves the events starting after an event with the given ID.

filtersobject

Filters for listing customer redeemables.

idobject1 fields

Unique redeemable holder ID, i.e. `rh_0e77502f84f0f4a6a8`.

created_atobject1 fields

Timestamp representing the date and time when the redeemable was added to the holder. The value is shown in the ISO 8601 format.

holder_roleobject1 fields

Holder role of the redeemable. Allowed values: `REFEREE`, `REFERRER`

customer_idobject1 fields

Unique customer ID, i.e. `cust_sehkNIi8Uq2qQuRqSr7xn4Zi`.

junctionstring

Logical Operator Between Filters. Filter by conditions set on the `junction` parameter indicating how the `conditions` should be accounted for in the query. An `AND` is an all-inclusive logical operator, meaning the `AND` operator displays a record if **ALL** the conditions separated by AND are TRUE, while an `OR` operator displays a record if **ANY** of the conditions separated by OR is TRUE.

One ofandor

Response

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

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

Referrals Code Holders — Voucherify — Documentation