Get redeemed rewards list
Integration
This method returns a list of all redeemed rewards in the system. If sorting is not chosen, the rows will be returned in an unspecified order. To sort a result, use an _orderBy parameter in query.
Open Loyalty has the JWT authorization. To learn what a JSON Web Token is and how it works, check out Introduction to JSON Web Tokens https://jwt.io/introduction/
Obtain an access token
Send a request with the parameters username and password
Definition
POST /api/admin/login_check Go to definition
Example
curl {HOST}/api/admin/login_check
-H 'Content-Type: application/json;charset=UTF-8'
-H 'Accept: application/json, text/plain, */*'
--data-binary '{"username":"admin","password":"password"}'
Example Response
{
"token":"eyJhbGciOiJSUzI1NiIsInR5cCI6...",
"refresh_token":"0558f8bb29948c4e54c443f..."
}
Using JSON Web Token
Add authorization header to each request
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6...
You can now access any API method you want under the /api prefix.
Example
curl {HOST}/api/{storeCode}/analytics/members
-H 'Accept: application/json'
-H 'Content-type: application/x-www-form-urlencoded'
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6...'
Refresh JSON Web Token
You can refresh token using refresh_token that was given during login.
To refresh admin token POST /api/token/refresh Go to definition
Store code
Scroll (cursor) pagination: the recommended way to fetch all records or any large volume of them. Unlike with _page, the cost of a request does not grow with how far into the result it is, see Scroll mechanism for pages.
- Send the first request with an empty
_scrollparameter:?_scroll. - Send the next request with the
scroll.nextvalue from the previous response:?_scroll=<scroll.next>. Keep the other query parameters unchanged. - Stop when the response has no
scroll.nextvalue: the last response has an emptyitemslist. You can stop earlier when a response has fewer items than_itemsOnPage.
Notes:
- Items are always returned in descending order of
createdAt, then of their id._orderByhas no effect (its values are still validated). _pagehas no effect (it must still be a valid page number)._itemsOnPagesets the number of items in one response.- Filters work the same way as in
_pagepagination. - A scroll response has no
total.
Items on one page, in both _page and _scroll pagination.
10Example: 25Number of the page with results, starts from 1.
Not for iterating over large data sets. The cost of a request grows with the page number: the database still reads and discards every row of the previous pages, so deep pages are slow and load the whole API. Use _page to browse the first pages of a result. The maximum value of _page is limited on some endpoints, see Limits.
To fetch all records, or any large volume of them, use the _scroll parameter where the endpoint offers it, see Scroll mechanism for pages.
1Example: 1Fortune Wheel draw date, use the [hasValue] / [notHasValue] key to get only drawn / not drawn redemptions
Transaction id related to
Campaign id related to
Custom event id related to
Internal event name related to
Labels using pattern e.g. (key1;value1),(key2;value2),...
List of Issued Reward
Bad request.
Forbidden.
GET /api/{storeCode}/redemption HTTP/1.1
Host: openloyalty.localhost
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"items": [
{
"rewardId": "123e4567-e89b-12d3-a456-426614174000",
"issuedRewardId": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"tax": 1,
"taxPriceValue": 1,
"price": 1,
"customerId": "123e4567-e89b-12d3-a456-426614174000",
"status": "text",
"redemptionDate": "2026-01-01T00:00:00.000Z",
"issuedCoupon": {
"code": "text",
"value": 1,
"activeFrom": "2026-01-01T00:00:00.000Z",
"activeTo": "2026-01-01T00:00:00.000Z",
"usedAt": "2026-01-01T00:00:00.000Z"
},
"customerData": {
"email": "text",
"firstName": "text",
"lastName": "text",
"phone": "text",
"loyaltyCardNumber": "text",
"address": {}
},
"costInPoints": 1,
"token": "text",
"rewardType": "static_coupon",
"actionCause": {
"campaignId": "123e4567-e89b-12d3-a456-426614174000",
"customerId": "123e4567-e89b-12d3-a456-426614174000",
"transactionId": "123e4567-e89b-12d3-a456-426614174000",
"customEventId": "123e4567-e89b-12d3-a456-426614174000",
"internalEventName": "text",
"performedAt": "2026-01-01T00:00:00.000Z",
"rewardId": "123e4567-e89b-12d3-a456-426614174000",
"issuedRewardId": "123e4567-e89b-12d3-a456-426614174000"
},
"cancelledAt": "2026-01-01T00:00:00.000Z"
}
]
}Last updated
Was this helpful?

