List Reward Assignments

GET/v1/rewards/{rewardId}/assignments

Use it in a workflow

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

rewardIdstringrequired

A unique reward ID.

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`.

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

objectstring

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

Default "list"

data_refstring

Identifies the name of the attribute that contains the array of reward assignments.

Default "data"

dataarray<object>

totalinteger

Total number of reward assignments.

json

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

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

Was this page helpful?