Get Loyalty Program Events (GET /v1/loyalty-programs/{id}/events)

Retrieves all Loyalty Events associated with a specific Loyalty Program.

URL test:

https://test.lightcms.io/loyalty/v1/loyalty-programs/{id}/events

Method:

GET

Path Items

/v1/loyalty-programs/{id}/events

Parameters

Name	Location	Type	Required	Description
id	path	integer (int64)	Yes	Identifier of the Loyalty Program (must be > 0).
eventtype	query	string	No	Filter by event type (CUSTOMER_CARD_DISPLAYED, TRANSACTION_ASSESSMENT, CARD_ASSIGNMENT).
page	query	integer (int32)	No	Zero‑based page index (default 0).
size	query	integer (int32)	No	Number of items per page (default 20).
sort	query	string	No	Sorting expression, e.g., timestamp,desc.

Example cURL

    curl -X GET "https://test.lightcms.io/loyalty/v1/loyalty-programs/12/events?eventtype=TRANSACTION_ASSESSMENT&page=0&size=20&sort=timestamp,desc" \
         -H "accept: */*"

Responses:

200 - OK

Status Code: 200 OK

[
  {
    "id": 301,
    "loyaltyAccountId": 987,
    "loyaltyProgramId": 12,
    "reward": {
      "id": 55,
      "rewardType": "LOYALTY_POINTS",
      "rewardAmount": 150,
      "rewardCurrency": "USD",
      "previousRewardAmount": 120,
      "customerMessage": "You've earned points!",
      "ruleId": 5,
      "trancoreId": 2001,
      "loyaltyEventId": 301,
      "createdAt": "2024-06-01T10:00:00Z",
      "updatedAt": "2024-06-01T10:05:00Z"
    },
    "eventType": "TRANSACTION_ASSESSMENT",
    "eventDetails": {},
    "timestamp": "2024-06-01T10:00:00Z",
    "createdAt": "2024-06-01T10:00:00Z",
    "updatedAt": "2024-06-01T10:05:00Z"
  }
]

Parameter	Location	Type	Description
id	body	integer (int64)	Unique identifier of the Loyalty Event.
loyaltyAccountId	body	integer (int64)	Identifier of the Loyalty Account linked to the event.
loyaltyProgramId	body	integer (int64)	Identifier of the Loyalty Program (matches the path id).
reward.id	body.reward	integer (int64)	Identifier of the Reward associated with the event.
reward.rewardType	body.reward	string	Type of reward (PERCENTAGE, FLAT_AMOUNT, LOYALTY_POINTS).
reward.rewardAmount	body.reward	number	Monetary or point value of the reward.
reward.rewardCurrency	body.reward	string	Currency code for monetary rewards (e.g., USD).
reward.previousRewardAmount	body.reward	number	Reward amount before the current update (if applicable).
reward.customerMessage	body.reward	string	Message shown to the customer regarding the reward.
reward.ruleId	body.reward	integer (int64)	Identifier of the rule that generated the reward.
reward.trancoreId	body.reward	integer (int64)	Transaction ID in Trancore associated with the reward.
reward.loyaltyEventId	body.reward	integer (int64)	Identifier of the Loyalty Event that produced the reward (mirrors outer id).
reward.createdAt	body.reward	string (date‑time)	Timestamp when the Reward record was created.
reward.updatedAt	body.reward	string (date‑time)	Timestamp of the last update to the Reward record.
eventType	body	string	Type of the event (CUSTOMER_CARD_DISPLAYED, TRANSACTION_ASSESSMENT, CARD_ASSIGNMENT).
eventDetails	body	object (JsonNode)	Additional details specific to the event type.
timestamp	body	string (date‑time)	Exact time the event occurred.
createdAt	body	string (date‑time)	Timestamp when the Loyalty Event record was created.
updatedAt	body	string (date‑time)	Timestamp of the last modification to the Loyalty Event record.

404 - Not Found

Status Code: 404 Not Found

{
"timestamp": "2026-02-04T12:16:34.897159276",
"status": 404,
"error": "Resource Not Found",
"message": "Loyalty program not found with id: 12121212"
}

Parameter	Location	Type	Description
timestamp	body	string (date‑time)	Time when the error response was generated.
status	body	integer	HTTP status code (404).
error	body	string	Short error label (“Resource Not Found”).
message	body	string	Detailed error message indicating the missing ID.