Get rewards
GET /v1/public/rewards
Lists the merchant's reward templates. Customer reward instances are available under /customers/{customerId}/rewards.
Authorization
X-API-Key required with the rewards:read scope
Parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
cursor | query | string | No | Opaque nextCursor returned by the previous list request. Do not construct or modify it. |
limit | query | integer | No | Maximum resources to return. |
active | query | boolean | No | Filter by active state. |
Request example
curl -X GET "https://api.remyrewards.co.uk/v1/public/rewards?limit=25" \
-H "Accept: application/json" \
-H "X-API-Key: YOUR_API_KEY"Responses
| Status | Description |
|---|---|
200 | Reward templates retrieved. |
400 | The request is missing a required value or contains invalid data. |
401 | The API key is missing or invalid. |
403 | The API key is valid but does not have the required scope. |
429 | A rate or concurrency limit was exceeded. |
Success response example
{
"success": true,
"data": [],
"pagination": {
"limit": 25,
"hasMore": false,
"nextCursor": null
}
}