Skip to main content

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

NameLocationTypeRequiredDescription
cursorquerystringNoOpaque nextCursor returned by the previous list request. Do not construct or modify it.
limitqueryintegerNoMaximum resources to return.
activequerybooleanNoFilter 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

StatusDescription
200Reward templates retrieved.
400The request is missing a required value or contains invalid data.
401The API key is missing or invalid.
403The API key is valid but does not have the required scope.
429A rate or concurrency limit was exceeded.

Success response example

{
"success": true,
"data": [],
"pagination": {
"limit": 25,
"hasMore": false,
"nextCursor": null
}
}