younifyd
Menu

List Loyalty Tiers

List Loyalty Tiers

GET/v1/loyalties/{campaignId}/tiers

Use it in a workflow

  1. Add a step and choose the Voucherify connector.
  2. Pick the List Loyalty Tiers action (under Loyalties).
  3. Fill in the fields below, then reference the result from later steps as {{listLoyaltyTiers.response.data}}.

Request

Path parameters

campaignIdstringrequired

Unique loyalty campaign ID or name.

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 ofcreated_at-created_atupdated_at-updated_at

Response

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

objectstring

The type of the object represented by JSON. This object stores information about loyalty tiers in a dictionary.

One oflistDefault "list"

data_refstring

Identifies the name of the attribute that contains the array of loyalty tier objects.

One ofdataDefault "data"

dataarray<any>

This is an object representing a loyalty tier. Loyalty tiers are used to create a loyalty program with different levels of membership and varied earning rules and rewards based on customer's tiers.

totalinteger

Total number of loyalty tier objects.

json
{
  "object": "list",
  "data_ref": "data",
  "data": [
    null
  ],
  "total": 0
}

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