younifyd
Menu

List Reward Assignments 2

List Campaign Rewards

GET/v1/loyalties/{campaignId}/rewards

Use it in a workflow

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

Request

Path parameters

campaignIdstringrequired

Unique campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the `name` of the campaign as the path parameter value, e.g., `Loyalty%20Campaign`.

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.

pageinteger

Which page of results to return. The lowest value is `1`.

assignment_idstring

A unique reward assignment ID.

Response

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

objectstring

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

One oflistDefault "list"

data_refstring

Identifies the name of the attribute that contains the array of reward assignment objects.

Default "data"

dataarray<object>

Contains array of reward assignment objects.

totalinteger

Total number of reward assignment objects.

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

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

List Reward Assignments 2 — Voucherify — Documentation