Audit

These endpoints will allow you to see the list of actions taken in Open Loyalty.

Get all system logs

get

Management This method returns all actions logged in system logs.

If sorting is not chosen, the rows will be returned in an unspecified order. To sort a result, use an _orderBy parameter in query.

Authorizations

Bearertoken

AuthorizationstringRequired

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
POST /api/{storeCode}/member/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.
There are two endpoints
To refresh admin token POST /api/token/refresh Go to definition
To refresh member token POST /api/{storeCode}/token/refresh Go to definition

Query parameters

eventTypestringOptional

entityIdstringOptional

entityTypestringOptional

usernamestringOptional

auditLogIdstringOptional

createdAtstringOptional

ipstringOptional

userTypestringOptional

storestringOptional

_pageintegerOptional

_itemsOnPageinteger · min: 1 · max: 50Optional

Items on one page

Default: 10Example: 25

_orderBystringOptional

Responses

200

Returned when successful

application/json

400

Bad request.

application/json

401Error

application/json

403

Forbidden.

application/json

get/api/audit/log

HTTPcURLJavaScriptPython

GET /api/audit/log HTTP/1.1
Host: openloyalty.localhost
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "auditLogId": "text",
      "store": {
        "storeId": "123e4567-e89b-12d3-a456-426614174000",
        "code": "text",
        "currency": "text",
        "name": "text",
        "active": true,
        "createdAt": "2026-07-18T16:39:56.332Z",
        "updatedAt": "2026-07-18T16:39:56.332Z",
        "createdBy": "text",
        "updatedBy": "text"
      },
      "eventType": "text",
      "entityType": "text",
      "entityId": "text",
      "username": "text",
      "userId": "text",
      "userType": "text",
      "ip": "text",
      "createdAt": "2026-07-18T16:39:56.332Z"
    }
  ]
}

Deprecated

Get system log archive

get

Management This method exports Audit Log archive.

Authorizations

Bearertoken

AuthorizationstringRequired

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
POST /api/{storeCode}/member/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.
There are two endpoints
To refresh admin token POST /api/token/refresh Go to definition
To refresh member token POST /api/{storeCode}/token/refresh Go to definition

Path parameters

filenamestringRequired

Responses

200

Returned when successful

application/xml

string · binaryOptional

401Error

application/json

403

Forbidden.

application/json

404

Not found.

application/json

get/api/audit/log/archive/{filename}

HTTPcURLJavaScriptPython

GET /api/audit/log/archive/{filename} HTTP/1.1
Host: openloyalty.localhost
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

<?xml version="1.0"?>
<object>binary</object>

Deprecated

Get system log archives list

get

Management This method exports Audit Log archives file list.

If sorting is not chosen, the rows will be returned in an unspecified order. To sort a result, use an _orderBy parameter in query.

Authorizations

Bearertoken

AuthorizationstringRequired

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
POST /api/{storeCode}/member/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.
There are two endpoints
To refresh admin token POST /api/token/refresh Go to definition
To refresh member token POST /api/{storeCode}/token/refresh Go to definition

Responses

200

Returned when successful

application/json

itemsstring[]Optional

401Error

application/json

403

Forbidden.

application/json

get/api/audit/log/archive

HTTPcURLJavaScriptPython

GET /api/audit/log/archive HTTP/1.1
Host: openloyalty.localhost
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    "text"
  ]
}

Deprecated

Create a new system log archive

post

Management This method creates a new Audit Log archive.

Authorizations

Bearertoken

AuthorizationstringRequired

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
POST /api/{storeCode}/member/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.
There are two endpoints
To refresh admin token POST /api/token/refresh Go to definition
To refresh member token POST /api/{storeCode}/token/refresh Go to definition

Body

application/json

Responses

200

Returned when successful

application/json

totalArchivedintegerOptionalExample: 32

filenamestringOptionalExample: filename

400

Bad request.

application/json

401Error

application/json

403

Forbidden.

application/json

post/api/audit/log/archive

HTTPcURLJavaScriptPython

POST /api/audit/log/archive HTTP/1.1
Host: openloyalty.localhost
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 39

{
  "archive": {
    "beforeDate": "2026-07-18"
  }
}

[
  {
    "totalArchived": 32,
    "filename": "filename"
  }
]

Deprecated

Export system log

get

This method exports Audit Log.

Authorizations

Bearertoken

AuthorizationstringRequired

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
POST /api/{storeCode}/member/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.
There are two endpoints
To refresh admin token POST /api/token/refresh Go to definition
To refresh member token POST /api/{storeCode}/token/refresh Go to definition

Query parameters

eventTypestringOptional

Event type

Default: null

entityIdstringOptional

Entity ID

Default: null

userIdstringOptional

User ID

Default: null

entityTypestringOptional

Entity Type

Default: null

usernamestringOptional

username

Default: null

auditLogIdstringOptional

audit log ID

Default: null

createdAtstringOptional

created at from

Default: null

directionstring · asc|descOptional

Sorting direction

_pageintegerOptional

Page number

_itemsOnPageinteger · min: 1 · max: 50Optional

Items on one page

Default: 10Example: 25

_orderBystringOptional

Field to sort by

Responses

200

Returned when successful

text/plaintext/csv

string · textOptional

400

Bad request.

application/json

401Error

application/json

403

Forbidden.

application/json

get/api/audit/log/export

HTTPcURLJavaScriptPython

GET /api/audit/log/export HTTP/1.1
Host: openloyalty.localhost
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

text

Get list of exports for system logs

get

Management

Authorizations

Bearertoken

AuthorizationstringRequired

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
POST /api/{storeCode}/member/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.
There are two endpoints
To refresh admin token POST /api/token/refresh Go to definition
To refresh member token POST /api/{storeCode}/token/refresh Go to definition

Query parameters

exportIdstring · uuidOptional

createdAtone ofOptional

string · date-timeOptional

Date and time value

or

statusstring · enumOptionalPossible values:

messagestringOptional

_pageinteger · min: 1Optional

Number of page with results, starts from 1

Default: 1Example: 1

_itemsOnPageinteger · min: 1 · max: 50Optional

Items on one page

Default: 10Example: 25

Responses

200

List of exports for system logs

application/json

401

Unauthorized

application/json

403

Forbidden.

application/json

get/api/system-log/export

HTTPcURLJavaScriptPython

GET /api/system-log/export HTTP/1.1
Host: openloyalty.localhost
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "exportId": "123e4567-e89b-12d3-a456-426614174000",
      "status": "done",
      "createdAt": "2026-07-18T16:39:56.332Z",
      "finishedAt": "2026-07-18T16:39:56.332Z",
      "criteria": "text",
      "exportedRows": 1,
      "message": "text"
    }
  ]
}

Create an export for system logs

post

Management

Authorizations

Bearertoken

AuthorizationstringRequired

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
POST /api/{storeCode}/member/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.
There are two endpoints
To refresh admin token POST /api/token/refresh Go to definition
To refresh member token POST /api/{storeCode}/token/refresh Go to definition

Body

application/json

Responses

200Success

application/json

exportIdstring · uuidRequired

400

Bad request.

application/json

403

Forbidden.

application/json

404

Not found.

application/json

post/api/system-log/export

HTTPcURLJavaScriptPython

POST /api/system-log/export HTTP/1.1
Host: openloyalty.localhost
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 92

{
  "systemLog": {
    "createdAt": null,
    "_page": 1,
    "_itemsOnPage": 25,
    "_orderBy": {
      "fieldName": "desc"
    }
  }
}

{
  "exportId": "123e4567-e89b-12d3-a456-426614174000"
}

Get an export for system logs

get

Management

Authorizations

Bearertoken

AuthorizationstringRequired

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
POST /api/{storeCode}/member/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.
There are two endpoints
To refresh admin token POST /api/token/refresh Go to definition
To refresh member token POST /api/{storeCode}/token/refresh Go to definition

Path parameters

exportstring · uuidRequired

Export ID

Responses

200

Export for system logs

application/json

exportIdstring · uuidRequired

statusstring · enumRequiredPossible values:

createdAtstring · date-timeRequired

finishedAtstring · date-timeOptional

criteriastringRequired

exportedRowsintegerOptional

messagestringOptional

400

Bad request.

application/json

403

Forbidden.

application/json

404

Not found.

application/json

get/api/system-log/export/{export}

HTTPcURLJavaScriptPython

GET /api/system-log/export/{export} HTTP/1.1
Host: openloyalty.localhost
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "exportId": "123e4567-e89b-12d3-a456-426614174000",
  "status": "done",
  "createdAt": "2026-07-18T16:39:56.332Z",
  "finishedAt": "2026-07-18T16:39:56.332Z",
  "criteria": "text",
  "exportedRows": 1,
  "message": "text"
}

Download an export for system logs

get

Management

Authorizations

Bearertoken

AuthorizationstringRequired

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
POST /api/{storeCode}/member/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.
There are two endpoints
To refresh admin token POST /api/token/refresh Go to definition
To refresh member token POST /api/{storeCode}/token/refresh Go to definition

Path parameters

exportstring · uuidRequired

Export ID

Responses

200

CSV File

No content

400

Bad request.

application/json

403

Forbidden.

application/json

404

Not found.

application/json

get/api/system-log/export/{export}/download

HTTPcURLJavaScriptPython

GET /api/system-log/export/{export}/download HTTP/1.1
Host: openloyalty.localhost
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content