List
Last updated
Last updated
The reward list endpoint allows you to list rewards for a specific search. If a search is not provided, it will return all rewards.
The example below searches for a reward. This returns an array of matched rewards with a list of vouchers and their states.
The response will contain an array of pathway reward combination objects which contains pathway details and rewards (which is the list of rewards on the pathway). This is the same structure as the reward webhook payload.
The voucher object will contain a guid which is used in the consume endpoint for rewards. This will allow integrations to set the voucher state if the intention is to manage redemption of awards via external systems.
Key
Type
search
Array String (Pathway / Reward ID or name)
DEPRECATED
keyword
String (Keyword search of pathways or rewards).
Key
Type
pathway
Object. The name and SKU of the related pathway.
rewards
Array. A list of rewards.
Key
Type
ID
String. ID or reward SKU reference.
name
String. The name of the reward.
vouchers
Array. A list of unredeemed vouchers.
Key
Type
guid
String. A GUID of the voucher.
state
String. The state of the voucher (pending, notified, verify, redeemed, expired).
expires
String. The date the voucher expires.
firstname
String
lastname
String
String
country
String
city
String