LoyaltyReward

Get Reward Page API

Returns a reward page

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
statestringOptionalDefaults to all
State of the reward
versionenumOptionalDefaults to draft
Version
Allowed values:

Response

Reward list successfully retrieved
itemslist of objects
Items for the current reward
totalCountinteger
Count of the associated parameter in current reward

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error
424
Failed Dependency Error
500
Internal Server Error