Get units transfers list
Management
This method returns a list of all Point transfers that have been created 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
Transfer id
Owner account id
Owner wallet id
Type
Value
Comment
Creator
cancelled
pending
createdAt
registeredOn
lockedUntil
expiresAt
Transaction id related to
Campaign id related to
Custom event id related to
Internal event name related to
Wallet type code related to
Member indentifier related to
Member email related to
Member phone number related to
Member loyalty card number related to
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: 1List of transfers
Bad request.
Unauthorized
Forbidden.
GET /api/{storeCode}/points HTTP/1.1
Host: openloyalty.localhost
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"items": [
{
"transferId": "123e4567-e89b-12d3-a456-426614174000",
"type": "text",
"accountId": "text",
"lockedUntil": "2026-01-01T00:00:00.000Z",
"expiresAt": "2026-01-01T00:00:00.000Z",
"storeId": "123e4567-e89b-12d3-a456-426614174000",
"comment": "text",
"cancelled": true,
"pending": true,
"unlockedAt": "2026-01-01T00:00:00.000Z",
"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": "text",
"issuedRewardId": "text"
},
"value": 1,
"externalTransferId": "text",
"createdAt": "2026-01-01T00:00:00.000Z",
"createdBy": "123e4567-e89b-12d3-a456-426614174000",
"walletType": {
"name": "text",
"code": "text",
"unitSingularName": "text",
"unitPluralName": "text"
},
"member": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"firstName": "text",
"lastName": "text",
"email": "text",
"phoneNumber": "text",
"loyaltyCardNumber": "text"
},
"labels": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
}
]
}Last updated
Was this helpful?

