List loyalty redemptions
Retrieve reward codes, or find one by code.
Endpoint
GET/loyalty-redemptions
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
organization_id | number | No | ID of your organization. Optional: results are always filtered to the API key's organization. |
search | string | No | Exact reward code, or part of the reward name |
member_id | number | No | Only codes of this card |
program_id | number | No | Only codes of this program |
reward_id | number | No | Only codes of this reward |
status | string | No | issued, used, cancelled or expired |
channel | string | No | staff, public_page, checkout, ai_assistant, api or automation |
$limit | number | No | Number of codes to return (default: 10, max: 50) |
$skip | number | No | Number of codes to skip (for pagination) |
$sort | object | No | Sort criteria, e.g. $sort[created_at]=-1 |
Request
Response
json
To resolve a code scanned at the counter together with its card, you can also use the scan action. To retrieve one redemption, see Get a loyalty redemption.
Report an issue with this documentation
Please log in to report issues with our documentation.