Get reward by ID
GET /v1/public/rewards/{id}
Returns one merchant reward template.
Authorization
X-API-Key required with the rewards:read scope
Parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | The resource's returned id or externalId. |
Request example
curl -X GET "https://api.remyrewards.co.uk/v1/public/rewards/66c735e253f2836fbe941234" \
-H "Accept: application/json" \
-H "X-API-Key: YOUR_API_KEY"Responses
| Status | Description |
|---|---|
200 | Reward template retrieved. |
401 | The API key is missing or invalid. |
403 | The API key is valid but does not have the required scope. |
404 | The requested integration resource was not found. |
429 | A rate or concurrency limit was exceeded. |
Success response example
{
"success": true,
"data": {
"id": "66c735e253f2836fbe941236",
"title": "Free Coffee",
"description": "Any regular coffee",
"active": true,
"expiryDays": 30
}
}