Get customer loyalty

GET /v1/public/customers/{id}/loyalty

Returns a consolidated customer view containing customer loyalty cards, customer rewards, and customer vouchers.

Authorization

X-API-Key required with the customers: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/customers/66c735e253f2836fbe941234/loyalty" \
  -H "Accept: application/json" \
  -H "X-API-Key: YOUR_API_KEY"

Responses

Status	Description
200	Customer loyalty state 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": {
    "customer": {
      "id": "66c735e253f2836fbe941235",
      "name": "Alex Morgan",
      "email": "alex@example.com"
    },
    "cards": [],
    "rewards": [],
    "vouchers": []
  }
}