Get customer rewards

GET /v1/public/customers/{customerId}/rewards

Lists reward instances belonging to one merchant customer.

Authorization

X-API-Key required with the customers:read scope

Parameters

Name	Location	Type	Required	Description
customerId	path	string	Yes	The customer's returned id or externalId.
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.
status	query	active, redeemed, expired	No	Filter by customer-reward status.

Request example

curl -X GET "https://api.remyrewards.co.uk/v1/public/customers/66c735e253f2836fbe941235/rewards?limit=25" \
  -H "Accept: application/json" \
  -H "X-API-Key: YOUR_API_KEY"

Responses

Status	Description
200	Customer rewards 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.
404	The requested integration resource was not found.
429	A rate or concurrency limit was exceeded.

Success response example

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