Get Loyalty Accounts list (GET /v1/loyalty-accounts)

Retrieves a list of Loyalty Accounts with optional pagination and filtering.

URL test:

https://test.lightcms.io/loyalty/v1/loyalty-accounts

Method:

GET

Path Items

/v1/loyalty-accounts

Parameters

Name	Location	Type	Required	Description
id	query	integer (int64)	No	Filter by internal Loyalty Account ID.
accountId	query	string	No	Filter by external account identifier.
holderId	query	string	No	Filter by holder identifier.
cardId	query	integer (int64)	No	Filter by associated Card ID.
programId	query	integer (int64)	No	Filter by Loyalty Program ID.
holderFirstName	query	string	No	Filter by holder’s first name.
holderSurname	query	string	No	Filter by holder’s surname.
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	Comma‑separated sorting fields, e.g., createdAt,desc.

Example cURL

    curl -X GET "https://test.lightcms.io/loyalty/v1/loyalty-accounts" \
         -H "accept: */*"

Responses:

200 - OK

Status Code: 200 OK

[
  {
    "id": 987,
    "loyaltyProgramId": 12,
    "cardId": 345,
    "accountId": 678,
    "holderId": "holder-abc-123",
    "holderFirstName": "Jane",
    "holderSurname": "Doe",
    "totalRewards": 1500.75,
    "totalRewardsCurrency": "USD",
    "createdAt": "2024-05-10T14:30:00Z",
    "updatedAt": "2025-01-22T09:15:00Z"
  },
  {
    "id": 988,
    "loyaltyProgramId": 13,
    "cardId": 346,
    "accountId": 679,
    "holderId": "holder-def-456",
    "holderFirstName": "John",
    "holderSurname": "Smith",
    "totalRewards": 250.00,
    "totalRewardsCurrency": "EUR",
    "createdAt": "2024-06-01T08:20:00Z",
    "updatedAt": "2025-02-10T11:45:00Z"
  }
]

Parameter	Location	Type	Description
id	body	integer (int64)	Unique identifier of the Loyalty Account.
loyaltyProgramId	body	integer (int64)	Identifier of the Loyalty Program the account belongs to.
cardId	body	integer (int64)	Identifier of the associated Card.
accountId	body	integer (int64)	External account identifier.
holderId	body	string	External holder identifier.
holderFirstName	body	string	First name of the holder.
holderSurname	body	string	Surname of the holder.
totalRewards	body	number	Accumulated reward amount for the account.
totalRewardsCurrency	body	string	Currency code for the total rewards (e.g., USD).
createdAt	body	string (date‑time)	Timestamp when the Loyalty Account was created.
updatedAt	body	string (date‑time)	Timestamp of the last update to the Loyalty Account.