List loyalty rewards

Retrieve the rewards of a loyalty program.

Endpoint

GET
/loyalty-rewards

Query parameters

NameTypeRequiredDescription
organization_idnumberNoID of your organization. Optional: results are always filtered to the API key's organization.
program_idnumberNoOnly rewards of this program
statusstringNoactive or inactive
reward_typestringNofree_item, discount_fixed, discount_percent or custom
$limitnumberNoNumber of rewards to return (default: 10, max: 50)
$skipnumberNoNumber of rewards to skip (for pagination)
$sortobjectNoSort criteria, e.g. $sort[cost]=1 or $sort[sort_order]=1

Request

Response

json

Report an issue with this documentation

Please log in to report issues with our documentation.