LoyaltyReward

Get voucher for a contact

Get voucher for a contact

Authentication

api-keystring

The API key should be passed in the request headers as api-key for authentication.

Path parameters

pidstringRequiredformat: "uuid"
Loyalty Program ID

Query parameters

limitintegerOptional1-100Defaults to 25
Page size
offsetintegerOptionalDefaults to 0
Pagination offset
sortenumOptionalDefaults to desc
Sort order
Allowed values:
sortFieldenumOptionalDefaults to updatedAt
Sort field
Allowed values:
contactIdintegerRequired>=1
Contact ID
metadata_key_valuestringOptional
Metadata value for a Key filter
rewardIdstringOptional
Reward ID

Response

Voucher list successfully retrieved
contactIdlong or null
Contact id associated with the current reward
contactRewardslist of objects or null
List of all the rewards for current contact
countinteger or null
Count of the rewards associated with the current contact
loyaltyProgramIdstring or null
Loyalty Program Id for the contact
loyaltySubscriptionIdstring or null
Loyalty Subscription Id for the contact

Errors