Member

These endpoints allow you to easily manage members.

Deprecated

Update member’s custom attribute

put

Integration This method allows updating Custom Attributes that are added to a specific Member.

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

storeCodestringRequired

Store code

memberstringRequiredPattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|email=[a-zA-Z0-9!#$%&'\.*+\-@=?^_`{|}~;]+|phone=[0-9+]+|loyaltyCardNumber=[0-9a-zA-Z\._-]+

Body

application/json

Responses

204

Success. No content.

No content

400

Bad request.

application/json

401Error

application/json

403

Forbidden.

application/json

404

Not found.

application/json

put/api/{storeCode}/member/{member}/custom-attribute

HTTPcURLJavaScriptPython

PUT /api/{storeCode}/member/{member}/custom-attribute HTTP/1.1
Host: openloyalty.localhost
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 52

{
  "customAttributes": [
    {
      "key": "text",
      "value": "text"
    }
  ]
}

No content

Deprecated

Delete member’s custom attribute

delete

Integration This method allows deleting Custom Attributes that are added to a specific Member.

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

storeCodestringRequired

Store code

memberstringRequiredPattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|email=[a-zA-Z0-9!#$%&'\.*+\-@=?^_`{|}~;]+|phone=[0-9+]+|loyaltyCardNumber=[0-9a-zA-Z\._-]+

Body

application/json

Responses

204

Success. No content.

No content

400

Bad request.

application/json

401Error

application/json

403

Forbidden.

application/json

404

Not found.

application/json

delete/api/{storeCode}/member/{member}/custom-attribute

HTTPcURLJavaScriptPython

DELETE /api/{storeCode}/member/{member}/custom-attribute HTTP/1.1
Host: openloyalty.localhost
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 52

{
  "customAttributes": [
    {
      "key": "text",
      "value": "text"
    }
  ]
}

No content

Mark coupon as used

post

Integration This method allows redeeming a Coupon that is assigned to a specific Member (marks it as used by the Administrator).

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

memberstringRequiredPattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|email=[a-zA-Z0-9!#$%&'\.*+\-@=?^_`{|}~;]+|phone=[0-9+]+|loyaltyCardNumber=[0-9a-zA-Z\._-]+

storeCodestringRequired

Store code

Body

application/json

couponCodestringRequired

Responses

200

Returned when successful

application/json

codestringOptional

usedbooleanOptional

customerIdstring · uuidOptional

400

Bad request.

application/json

401Error

application/json

403

Forbidden.

application/json

404

Not found.

application/json

409

Conflict — the resource is already being processed by another concurrent request.

application/json

post/api/{storeCode}/member/{member}/reward/redeem

HTTPcURLJavaScriptPython

POST /api/{storeCode}/member/{member}/reward/redeem HTTP/1.1
Host: openloyalty.localhost
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 21

{
  "couponCode": "text"
}

{
  "code": "text",
  "used": true,
  "customerId": "123e4567-e89b-12d3-a456-426614174000"
}

Mark coupon as unused

post

Integration This method allows reissuing a Coupon that is assigned to a specific Member (marks it as unused by the Administrator).

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

memberstringRequiredPattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|email=[a-zA-Z0-9!#$%&'\.*+\-@=?^_`{|}~;]+|phone=[0-9+]+|loyaltyCardNumber=[0-9a-zA-Z\._-]+

storeCodestringRequired

Store code

Body

application/json

couponCodestringRequired

Responses

200

Returned when successful

application/json

codestringOptional

usedbooleanOptional

customerIdstring · uuidOptional

400

Bad request.

application/json

401Error

application/json

403

Forbidden.

application/json

404

Not found.

application/json

post/api/{storeCode}/member/{member}/reward/reissue

HTTPcURLJavaScriptPython

POST /api/{storeCode}/member/{member}/reward/reissue HTTP/1.1
Host: openloyalty.localhost
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 21

{
  "couponCode": "text"
}

{
  "code": "text",
  "used": true,
  "customerId": "123e4567-e89b-12d3-a456-426614174000"
}

Get member’s details

get

Integration This method returns details related to a specific Member account.

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

memberstringRequiredPattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|email=[a-zA-Z0-9!#$%&'\.*+\-@=?^_`{|}~;]+|phone=[0-9+]+|loyaltyCardNumber=[0-9a-zA-Z\._-]+

storeCodestringRequired

Store code

Query parameters

customFieldsstringOptional

Comma-separated list of custom field group names to include in the response. If omitted, all custom fields are returned.

Example: group1,group2

Responses

200

Member details

application/json

customerIdstring · uuidOptional

registeredAtstring · date-timeOptional

activebooleanOptional

channelIdstring · uuidOptional

firstNamestringOptional

lastNamestringOptional

genderstringOptional

emailstringOptional

phonestringOptional

birthDatestring · date-timeOptional

lastLevelRecalculationstring · date-timeOptional

loyaltyCardNumberstringOptional

createdAtstring · date-timeOptional

updatedAtstring · date-timeOptional

agreement1booleanOptional

agreement2booleanOptional

agreement3booleanOptional

transactionsCountintegerOptional

returnTransactionsCountintegerOptional

transactionsAmountnumber · floatOptional

returnTransactionsAmountnumber · floatOptional

transactionsAmountWithoutDeliveryCostsnumber · floatOptional

amountExcludedForLevelnumber · floatOptional

averageTransactionAmountnumber · floatOptional

averageReturnTransactionAmountnumber · floatOptional

lastTransactionDatestring · date-timeOptional

firstTransactionDatestring · date-timeOptional

levelAchievementDatestring · date-timeOptional

anonymizedbooleanOptional

referralTokenstringOptional

currencystringOptional

storeCodestringOptional

segmentsstring · uuid[]Optional

channelIdentifierstringOptional

400

Bad request.

application/json

401

Unauthorized.

application/json

403

Forbidden.

application/json

404

Not found.

application/json

get/api/{storeCode}/member/{member}

HTTPcURLJavaScriptPython

GET /api/{storeCode}/member/{member} HTTP/1.1
Host: openloyalty.localhost
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "customerId": "123e4567-e89b-12d3-a456-426614174000",
  "registeredAt": "2026-07-18T16:32:29.544Z",
  "active": true,
  "channelId": "123e4567-e89b-12d3-a456-426614174000",
  "firstName": "text",
  "lastName": "text",
  "gender": "text",
  "email": "text",
  "phone": "text",
  "birthDate": "2026-07-18T16:32:29.544Z",
  "lastLevelRecalculation": "2026-07-18T16:32:29.544Z",
  "address": {
    "street": "text",
    "address1": "text",
    "address2": "text",
    "province": "text",
    "city": "text",
    "postal": "text",
    "country": "text"
  },
  "loyaltyCardNumber": "text",
  "createdAt": "2026-07-18T16:32:29.544Z",
  "updatedAt": "2026-07-18T16:32:29.544Z",
  "agreement1": true,
  "agreement2": true,
  "agreement3": true,
  "company": {
    "name": "text",
    "nip": "text"
  },
  "transactionsCount": 1,
  "returnTransactionsCount": 1,
  "transactionsAmount": 1,
  "returnTransactionsAmount": 1,
  "transactionsAmountWithoutDeliveryCosts": 1,
  "amountExcludedForLevel": 1,
  "averageTransactionAmount": 1,
  "averageReturnTransactionAmount": 1,
  "lastTransactionDate": "2026-07-18T16:32:29.544Z",
  "firstTransactionDate": "2026-07-18T16:32:29.544Z",
  "levelAchievementDate": "2026-07-18T16:32:29.544Z",
  "anonymized": true,
  "referralToken": "text",
  "defaultAccount": {
    "accountId": "text",
    "activePoints": 1,
    "transferredPoints": 1,
    "lockedPoints": 1,
    "expiredPoints": 1,
    "spentPoints": 1,
    "earnedPoints": 1,
    "blockedPoints": 1
  },
  "customFieldsData": [
    {
      "customFieldSchemaId": "123e4567-e89b-12d3-a456-426614174000",
      "customFieldName": "text",
      "customFieldType": "text",
      "value": "text"
    }
  ],
  "labels": [
    {
      "key": "text",
      "value": "text"
    }
  ],
  "currency": "text",
  "storeCode": "text",
  "segments": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "channelIdentifier": "text",
  "currentLevel": {
    "levelId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "translations": {
      "en": {
        "name": "text",
        "description": "text"
      },
      "pl": {
        "name": "text",
        "description": "text"
      }
    }
  }
}

Update member’s details

put

Management This method allows updating data related to a specific Member account. If a member changes the primary identification method then this change has to be confirmed. Confirmation works only for email and phone fields. If CustomerEmailWasChanged or CustomerPhoneNumberWasChanged webhook is configured, the code, code number, and member contact data will be transmitted. Field code from the webhook has to be used as token parameter in endpoint. confirm change

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

memberstringRequiredPattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|email=[a-zA-Z0-9!#$%&'\.*+\-@=?^_`{|}~;]+|phone=[0-9+]+|loyaltyCardNumber=[0-9a-zA-Z\._-]+

storeCodestringRequired

Store code

Body

application/json

Responses

200

Return updated member id.

application/json

customerIdstringOptional

Updated member identity

Example: 00000000-0000-0000-0000-000000000000

400

Bad request.

application/json

401

Unauthorized.

application/json

403

Forbidden.

application/json

404

Not found.

application/json

405

Method Not Allowed.

application/json

put/api/{storeCode}/member/{member}

HTTPcURLJavaScriptPython

PUT /api/{storeCode}/member/{member} HTTP/1.1
Host: openloyalty.localhost
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 80

{
  "customer": {
    "firstName": "John",
    "lastName": "Doe",
    "email": "[e-mail]"
  }
}

{
  "customerId": "00000000-0000-0000-0000-000000000000"
}

Delete a member

delete

Management This method allows removing a specific Member account.

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

memberstringRequiredPattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|email=[a-zA-Z0-9!#$%&'\.*+\-@=?^_`{|}~;]+|phone=[0-9+]+|loyaltyCardNumber=[0-9a-zA-Z\._-]+

storeCodestringRequired

Store code

Responses

204

Success. No content.

No content

401

Unauthorized.

application/json

403

Forbidden.

application/json

404

Not found.

application/json

delete/api/{storeCode}/member/{member}

HTTPcURLJavaScriptPython

DELETE /api/{storeCode}/member/{member} HTTP/1.1
Host: openloyalty.localhost
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Partially update member details

patch

Management Allows partial update of member's custom attributes (labels) and custom fields data.

Two formats are supported:

1. New format (recommended):

   • Labels as associative array (object with key-value pairs)

   • Adding: To add a new label, provide a new key with its value.

   • Editing: To update an existing label, provide its key with a new value.

   • Removing: To remove a label, provide its key and set the value to null.

   • Only provided labels will be updated, other labels remain unchanged.

2. Legacy format (deprecated, will be removed soon):

   • Labels as array of objects with key and value properties

   • Replaces all existing labels - use with caution!

Member identifiers (email, phone, loyaltyCardNumber) can also be partially updated. Only the identifiers present in the request are changed; all other member data is preserved. Editing identifiers is admin-only and is applied directly (no confirmation flow). A non-admin member sending any of these fields receives a 400 response. Members change their own email/phone (with the confirmation flow) via the PUT member endpoint instead.

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

storeCodestringRequired

Store code

memberstringRequiredPattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|email=[a-zA-Z0-9!#$%&'\.*+\-@=?^_`{|}~;]+|phone=[0-9+]+|loyaltyCardNumber=[0-9a-zA-Z\._-]+

Body

application/json

Responses

200

Member successfully updated

application/json

customerIdstring · uuidOptional

Updated member identity

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden.

application/json

404

Not found.

application/json

patch/api/{storeCode}/member/{member}

HTTPcURLJavaScriptPython

PATCH /api/{storeCode}/member/{member} HTTP/1.1
Host: openloyalty.localhost
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 290

{
  "customer": {
    "labels": {
      "size": "L",
      "color": "blue",
      "oldLabel": null
    },
    "customFieldsData": [
      {
        "customFieldSchemaId": "123e4567-e89b-12d3-a456-426614174000",
        "value": "text"
      }
    ],
    "customFields": {
      "driving": {
        "score": 90,
        "risk": null
      }
    },
    "email": "[e-mail]",
    "phone": "text",
    "loyaltyCardNumber": "text"
  }
}

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

Deprecated

Find if the member registered

get

Integration This method returns true or false if a Member with give phone number or email exists.

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

storeCodestringRequired

Store code

Query parameters

emailOrPhonestringOptionalDeprecated

This filter is deprecated. Use identifier instead

Default: null

identifierstringOptional

Using this parameter you can filter by e-mail, by phone, by customer id or loyalty card number

Default: null

Responses

200

Returns true or false if given email or phone exists.

application/json

totalintegerOptional

400

Bad request.

application/json

401

Unauthorized.

application/json

403

Forbidden.

application/json

404

Not found.

application/json

get/api/{storeCode}/member/check

HTTPcURLJavaScriptPython

GET /api/{storeCode}/member/check HTTP/1.1
Host: openloyalty.localhost
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "total": 1
}

Get members list

get

Integration This method returns list of all Members' accounts exist 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.

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

storeCodestringRequired

Store code

Query parameters

customerIdstringOptional

firstNamestringOptional

lastNamestringOptional

emailOrPhonestringOptionalDeprecated

This filter is deprecated.

identifierstringOptionalDeprecated

This filter is deprecated. To get member by email, phone, loyaltyCardNumnber, use /api/{store}/member/email=[e-mail]).

activebooleanOptional

genderstringOptional

phonestringOptional

emailstringOptional

loyaltyCardNumberstringOptional

createdAtstring · date-timeOptional

birthDatestring · date-timeOptional

agreement1booleanOptional

agreement2booleanOptional

agreement3booleanOptional

updatedAtstring · date-timeOptional

registeredAtstring · date-timeOptional

transactionsCountintegerOptional

transactionsAmountnumberOptional

transactionsAmountWithoutDeliveryCostsnumberOptional

amountExcludedForLevelnumberOptional

averageTransactionAmountnumberOptional

levelAchievementDatestring · date-timeOptional

labelsstringOptional

Labels using pattern e.g. (key1;value1),(key2;value2),...

lastTransactionDatestring · date-timeOptional

firstTransactionDatestring · date-timeOptional

levelIdstringOptional

manuallyAssignedLevelIdstringOptional

referralTokenstringOptional

address:streetstringOptional

address:address1stringOptional

address:address2stringOptional

address:provincestringOptional

address:citystringOptional

address:postalstringOptional

address:countrystringOptional

defaultAccount:activePointsnumberOptional

defaultAccount:transferredPointsnumberOptional

defaultAccount:lockedPointsnumberOptional

defaultAccount:expiredPointsnumberOptional

defaultAccount:spentPointsnumberOptional

defaultAccount:earnedPointsnumberOptional

defaultAccount:blockedPointsnumberOptional

_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

_scrollstringOptional

To use scroll pagination, add the _scroll parameter to your query: ?_scroll

To retrieve the next page, take the scroll value from the previous response and use it in the next request: ?_scroll=eyJjcmVhdGVkQXQiOiIyMDI1LTA3LTAxIDEzOjU2OjI5LjAyMTcwMyIsImlkIjoiNTM5N2RiYzYtZGVkMi00MTQ0LTlhMjQtOTRjYmI5YWVjNDBjIn0=

Notes:

• Scroll pagination does not support sorting with _orderBy.
• Items are returned in ascending order by the createdAt field by default.

Responses

200

List of members

application/json

or

400

Bad request.

application/json

401

Unauthorized.

application/json

403

Forbidden.

application/json

404

Not found.

application/json

get/api/{storeCode}/member

HTTPcURLJavaScriptPython

GET /api/{storeCode}/member HTTP/1.1
Host: openloyalty.localhost
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "customerId": "123e4567-e89b-12d3-a456-426614174000",
      "registeredAt": "2026-07-18T16:32:29.544Z",
      "active": true,
      "channelId": "123e4567-e89b-12d3-a456-426614174000",
      "firstName": "text",
      "lastName": "text",
      "gender": "text",
      "email": "text",
      "phone": "text",
      "birthDate": "2026-07-18T16:32:29.544Z",
      "lastLevelRecalculation": "2026-07-18T16:32:29.544Z",
      "address": {
        "street": "text",
        "address1": "text",
        "address2": "text",
        "province": "text",
        "city": "text",
        "postal": "text",
        "country": "text"
      },
      "loyaltyCardNumber": "text",
      "createdAt": "2026-07-18T16:32:29.544Z",
      "updatedAt": "2026-07-18T16:32:29.544Z",
      "agreement1": true,
      "agreement2": true,
      "agreement3": true,
      "company": {
        "name": "text",
        "nip": "text"
      },
      "transactionsCount": 1,
      "returnTransactionsCount": 1,
      "transactionsAmount": 1,
      "returnTransactionsAmount": 1,
      "transactionsAmountWithoutDeliveryCosts": 1,
      "amountExcludedForLevel": 1,
      "averageTransactionAmount": 1,
      "averageReturnTransactionAmount": 1,
      "lastTransactionDate": "2026-07-18T16:32:29.544Z",
      "firstTransactionDate": "2026-07-18T16:32:29.544Z",
      "levelAchievementDate": "2026-07-18T16:32:29.544Z",
      "anonymized": true,
      "referralToken": "text",
      "defaultAccount": {
        "accountId": "text",
        "activePoints": 1,
        "transferredPoints": 1,
        "lockedPoints": 1,
        "expiredPoints": 1,
        "spentPoints": 1,
        "earnedPoints": 1,
        "blockedPoints": 1
      },
      "customFieldsData": [
        {
          "customFieldSchemaId": "123e4567-e89b-12d3-a456-426614174000",
          "customFieldName": "text",
          "customFieldType": "text",
          "value": "text"
        }
      ],
      "labels": [
        {
          "key": "text",
          "value": "text"
        }
      ],
      "currency": "text",
      "storeCode": "text",
      "channelIdentifier": "text"
    }
  ]
}

Add a member

post

Integration This method allows registering a new Member as an Admin.

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

storeCodestringRequired

Store code

Body

application/json

Responses

200

Return registered member id and identifiers.

application/json

customerIdstring · uuidOptional

Registered member identity

Example: 00000000-0000-0000-0000-000000000000

emailstringOptional

Registered member email

phonestring · nullableOptional

Registered member phone

loyaltyCardNumberstring · nullableOptional

Registered member loyalty card number

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden.

application/json

404

Not found.

application/json

post/api/{storeCode}/member

HTTPcURLJavaScriptPython

POST /api/{storeCode}/member HTTP/1.1
Host: openloyalty.localhost
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 660

{
  "customer": {
    "referrerToken": "text",
    "firstName": "text",
    "lastName": "text",
    "email": "text",
    "phone": "text",
    "loyaltyCardNumber": "text",
    "birthDate": "2026-07-18",
    "registeredAt": "2026-07-18T16:32:29.544Z",
    "address": {
      "street": "text",
      "address1": "text",
      "address2": "text",
      "postal": "text",
      "city": "text",
      "province": "text",
      "country": "text"
    },
    "company": {
      "name": "text",
      "nip": "text"
    },
    "labels": [
      {
        "key": "text",
        "value": "text"
      }
    ],
    "agreement1": true,
    "agreement2": true,
    "agreement3": true,
    "levelId": "123e4567-e89b-12d3-a456-426614174000",
    "channelId": "123e4567-e89b-12d3-a456-426614174000",
    "customFieldsData": [
      {
        "customFieldSchemaId": "123e4567-e89b-12d3-a456-426614174000",
        "value": "text"
      }
    ]
  }
}

{
  "customerId": "00000000-0000-0000-0000-000000000000",
  "email": "text",
  "phone": "text",
  "loyaltyCardNumber": "text"
}

Get number of registered members

get

Management This method returns the number of Members that have been registered in the system.

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

storeCodestringRequired

Store code

Query parameters

lastDaysintegerOptional

Range from last X days

Default: 30

intervalstring · day|month|yearOptional

Group by interval

Default: dayPattern: (day|month|year)

Responses

200Success

application/json

Other propertiesintegerOptional

404

Not found.

application/json

get/api/{storeCode}/member/registrations

HTTPcURLJavaScriptPython

GET /api/{storeCode}/member/registrations HTTP/1.1
Host: openloyalty.localhost
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": 1
}

Deprecated

Get member’s loyalty status

get

This method returns all the details related to a specific Member about Points, Transactions, Tier, etc.

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

memberstringRequiredPattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|email=[a-zA-Z0-9!#$%&'\.*+\-@=?^_`{|}~;]+|phone=[0-9+]+|loyaltyCardNumber=[0-9a-zA-Z\._-]+

storeCodestringRequired

Store code

Responses

200Success

application/json

firstNamestringOptional

lastNamestringOptional

customerIdstring · uuidOptional

activePointsnumber · floatOptional

transferredPointsnumber · floatOptional

earnedPointsnumber · floatOptional

spentPointsnumber · floatOptional

expiredPointsnumber · floatOptional

lockedPointsnumber · floatOptional

blockedPointsnumber · floatOptional

levelNamestringOptional

levelConditionValuenumber · floatOptional

nextLevelNamestringOptionalDeprecated

This property only shows correct data for tier sets with one condition.

nextLevelConditionValuenumber · floatOptionalDeprecated

This property only shows correct data for tier sets with one condition.

transactionsAmountToNextLevelWithoutDeliveryCostsnumber · floatOptional

transactionsAmountWithoutDeliveryCostsnumber · floatOptional

transactionsAmountToNextLevelnumber · floatOptional

averageTransactionsAmountnumber · floatOptional

averageReturnTransactionsAmountnumber · floatOptional

transactionsCountintegerOptional

returnTransactionsCountintegerOptional

transactionsAmountnumber · floatOptional

returnTransactionsAmountnumber · floatOptional

pointsToNextLevelnumber · floatOptionalDeprecated

This property only shows correct data for tier sets with one condition.

currencystringOptional

levelWillExpireInDaysintegerOptional

pointsSinceLastLevelRecalculationnumber · floatOptional

pointsRequiredToRetainLevelnumber · floatOptional

pointsExpiringNextMonthnumber · floatOptional

storeCodestringOptional

firstTransactionDatestring · date-timeOptional

lastTransactionDatestring · date-timeOptional

levelAchievementDatestring · date-timeOptional

createdAtstring · date-timeOptional

registeredAtstring · date-timeOptional

referralTokenstringOptional

403

Forbidden.

application/json

404

Not found.

application/json

get/api/{storeCode}/member/{member}/status

HTTPcURLJavaScriptPython

GET /api/{storeCode}/member/{member}/status HTTP/1.1
Host: openloyalty.localhost
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "firstName": "text",
  "lastName": "text",
  "customerId": "123e4567-e89b-12d3-a456-426614174000",
  "activePoints": 1,
  "transferredPoints": 1,
  "earnedPoints": 1,
  "spentPoints": 1,
  "expiredPoints": 1,
  "lockedPoints": 1,
  "blockedPoints": 1,
  "levelName": "text",
  "levelConditionValue": 1,
  "transactionsAmountToNextLevelWithoutDeliveryCosts": 1,
  "transactionsAmountWithoutDeliveryCosts": 1,
  "transactionsAmountToNextLevel": 1,
  "averageTransactionsAmount": 1,
  "averageReturnTransactionsAmount": 1,
  "transactionsCount": 1,
  "returnTransactionsCount": 1,
  "transactionsAmount": 1,
  "returnTransactionsAmount": 1,
  "currency": "text",
  "levelWillExpireInDays": 1,
  "pointsSinceLastLevelRecalculation": 1,
  "pointsRequiredToRetainLevel": 1,
  "tierSet": {
    "tierSetId": "text",
    "name": "text",
    "isMigrated": true
  },
  "pointsExpiringNextMonth": 1,
  "pointsExpiringBreakdown": {
    "ANY_ADDITIONAL_PROPERTY": 1
  },
  "storeCode": "text",
  "firstTransactionDate": "2026-07-18T16:32:29.544Z",
  "lastTransactionDate": "2026-07-18T16:32:29.544Z",
  "levelAchievementDate": "2026-07-18T16:32:29.544Z",
  "createdAt": "2026-07-18T16:32:29.544Z",
  "registeredAt": "2026-07-18T16:32:29.544Z",
  "referralToken": "text"
}

Activate a member

post

Management This method allows activating a specific Member account.

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

memberstringRequiredPattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|email=[a-zA-Z0-9!#$%&'\.*+\-@=?^_`{|}~;]+|phone=[0-9+]+|loyaltyCardNumber=[0-9a-zA-Z\._-]+

storeCodestringRequired

Store code

Responses

204

Success. No content.

No content

400

Bad request.

application/json

404

Not found.

application/json

post/api/{storeCode}/member/{member}/activate

HTTPcURLJavaScriptPython

POST /api/{storeCode}/member/{member}/activate HTTP/1.1
Host: openloyalty.localhost
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Deprecated

Activate a member with a token

post

Management This method allows activating by activation token a specific Member account.

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

storeCodestringRequired

Store code

tokenstringRequired

Responses

204

Success. No content.

No content

404

Not found.

application/json

post/api/{storeCode}/member/activate/{token}

HTTPcURLJavaScriptPython

POST /api/{storeCode}/member/activate/{token} HTTP/1.1
Host: openloyalty.localhost
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Anonymize member’s data

post

Management This method allows anonymizing a specific member account.

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

memberstringRequiredPattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|email=[a-zA-Z0-9!#$%&'\.*+\-@=?^_`{|}~;]+|phone=[0-9+]+|loyaltyCardNumber=[0-9a-zA-Z\._-]+

storeCodestringRequired

Store code

Responses

204

Success. No content.

No content

400

Bad request.

application/json

404

Not found.

application/json

post/api/{storeCode}/member/{member}/anonymize

HTTPcURLJavaScriptPython

POST /api/{storeCode}/member/{member}/anonymize HTTP/1.1
Host: openloyalty.localhost
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Assign channel to a member

post

Management This method allows assigning a Sales Channel to Member.

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

memberstringRequiredPattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|email=[a-zA-Z0-9!#$%&'\.*+\-@=?^_`{|}~;]+|phone=[0-9+]+|loyaltyCardNumber=[0-9a-zA-Z\._-]+

storeCodestringRequired

Store code

Body

application/json

channelIdstring · uuidOptional

Id of the sales channel to assign to the member

Responses

204

Success. No content.

No content

400

Bad request.

application/json

404

Not found.

application/json

post/api/{storeCode}/member/{member}/channel

HTTPcURLJavaScriptPython

POST /api/{storeCode}/member/{member}/channel HTTP/1.1
Host: openloyalty.localhost
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 52

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

No content

Confirm change with a token

post

Management This method allows confirming changes with a token.

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

storeCodestringRequired

Store code

tokenstringRequired

Responses

204

Success. No content.

No content

400

Bad request.

application/json

403

Forbidden.

application/json

404

Not found.

application/json

post/api/{storeCode}/member/confirm-change/{token}

HTTPcURLJavaScriptPython

POST /api/{storeCode}/member/confirm-change/{token} HTTP/1.1
Host: openloyalty.localhost
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Deactivate a member

post

Management This method allows deactivating a specific Member account.

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

memberstringRequiredPattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|email=[a-zA-Z0-9!#$%&'\.*+\-@=?^_`{|}~;]+|phone=[0-9+]+|loyaltyCardNumber=[0-9a-zA-Z\._-]+

storeCodestringRequired

Store code

Responses

204

Success. No content.

No content

400

Bad request.

application/json

403

Forbidden.

application/json

404

Not found.

application/json

post/api/{storeCode}/member/{member}/deactivate

HTTPcURLJavaScriptPython

POST /api/{storeCode}/member/{member}/deactivate HTTP/1.1
Host: openloyalty.localhost
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Deprecated

Register a member

post

Integration This method allows potential Members to register themselves. If CustomerWasRegisteredWithoutActivation webhook is configured, the code, code number, and member contact data will be transmitted. The 'code' field from the webhook should be used as token parameter in the endpoint. member activate

Path parameters

storeCodestringRequired

Store code

Body

application/json

Responses

200

Return registered member ID and email.

application/json

customerIdstringOptional

Registered member identity

Example: 00000000-0000-0000-0000-000000000000

emailstring · emailOptional

Registered member email

400

Bad request.

application/json

404

Not found.

application/json

post/api/{storeCode}/member/register

HTTPcURLJavaScriptPython

POST /api/{storeCode}/member/register HTTP/1.1
Host: openloyalty.localhost
Content-Type: application/json
Accept: */*
Content-Length: 414

{
  "customer": {
    "referrerToken": "text",
    "firstName": "text",
    "lastName": "text",
    "gender": "male",
    "email": "text",
    "phone": "text",
    "loyaltyCardNumber": "text",
    "birthDate": "2026-07-18",
    "registeredAt": "2026-07-18T16:32:29.544Z",
    "address": {},
    "company": {},
    "labels": [
      {
        "key": "text",
        "value": "text"
      }
    ],
    "customFieldsData": [
      {
        "customFieldSchemaId": "text"
      }
    ],
    "agreement1": true,
    "agreement2": true,
    "agreement3": true,
    "plainPassword": "password"
  }
}

{
  "customerId": "00000000-0000-0000-0000-000000000000",
  "email": "[e-mail]"
}

Remove manually assigned tier

post

Remove manually assigned tier

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

storeCodestringRequired

Store code

memberstringRequiredPattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|email=[a-zA-Z0-9!#$%&'\.*+\-@=?^_`{|}~;]+|phone=[0-9+]+|loyaltyCardNumber=[0-9a-zA-Z\._-]+

Body

application/json

tierSetIdstring · uuidOptional

tier set id specifies the tier set in which you want to remove the manually assigned tier

Responses

204

Success. No content.

No content

400

Bad request.

application/json

403

Forbidden.

application/json

404

Not found.

application/json

post/api/{storeCode}/member/{member}/remove-manually-level

HTTPcURLJavaScriptPython

POST /api/{storeCode}/member/{member}/remove-manually-level HTTP/1.1
Host: openloyalty.localhost
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 52

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

No content

Deprecated

Request activation code

post

Integration This method allows resending the activation code. Use given code in member activation endpoint as token parameter. member activation

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

storeCodestringRequired

Store code

Body

application/json

phonestringRequired

Responses

204

Success. No content.

No content

400

Bad request.

application/json

404

Not found.

application/json

post/api/{storeCode}/member/resend-code

HTTPcURLJavaScriptPython

POST /api/{storeCode}/member/resend-code HTTP/1.1
Host: openloyalty.localhost
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "phone": "text"
}

No content

Resend activation code

post

Integration This method allows resending the activation code for chosen member Use given code in member activation endpoint as token parameter. member activation

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

memberstringRequiredPattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|email=[a-zA-Z0-9!#$%&'\.*+\-@=?^_`{|}~;]+|phone=[0-9+]+|loyaltyCardNumber=[0-9a-zA-Z\._-]+

storeCodestringRequired

Store code

Responses

204

Success. No content.

No content

403

Forbidden.

application/json

404

Not found.

application/json

post/api/{storeCode}/member/{member}/send-code

HTTPcURLJavaScriptPython

POST /api/{storeCode}/member/{member}/send-code HTTP/1.1
Host: openloyalty.localhost
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Assign member to a tier

post

Assign member to a tier

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

storeCodestringRequired

Store code

memberstringRequiredPattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|email=[a-zA-Z0-9!#$%&'\.*+\-@=?^_`{|}~;]+|phone=[0-9+]+|loyaltyCardNumber=[0-9a-zA-Z\._-]+

Body

application/json

levelIdstring · uuidRequired

Id of the tier to assign to the member

Responses

204

Success. No content.

No content

400

Bad request.

application/json

403

Forbidden.

application/json

404

Not found.

application/json

post/api/{storeCode}/member/{member}/tier

HTTPcURLJavaScriptPython

POST /api/{storeCode}/member/{member}/tier HTTP/1.1
Host: openloyalty.localhost
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 50

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

No content

Update member’s password

put

Management This method allows logged Member changing password.

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

storeCodestringRequired

Store code

Body

application/json

currentPasswordstring · passwordRequired

plainPasswordstring · passwordRequired

Responses

204

Success. No content.

No content

400

Bad request.

application/json

403

Forbidden.

application/json

404

Not found.

application/json

put/api/{storeCode}/member/password

HTTPcURLJavaScriptPython

PUT /api/{storeCode}/member/password HTTP/1.1
Host: openloyalty.localhost
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 57

{
  "currentPassword": "password",
  "plainPassword": "password"
}

No content

Get logged member’s units

get

Integration This method returns a list of all Points transfers related to the logged Member. 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

Path parameters

storeCodestringRequired

Store code

Query parameters

typestringOptional

type

valuenumberOptional

value

commentstringOptional

comment

createdBystringOptional

createdBy

cancelledbooleanOptional

cancelled

pendingbooleanOptional

pending

createdAtstring · date-timeOptional

createdAt

lockedUntilstring · date-timeOptional

lockedUntil

expiresAtstring · date-timeOptional

expiresAt

walletType:codestringOptional

Wallet type code related to

_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 messages

application/json

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden.

application/json

get/api/{storeCode}/member/points

HTTPcURLJavaScriptPython

GET /api/{storeCode}/member/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-07-18T16:32:29.544Z",
      "expiresAt": "2026-07-18T16:32:29.544Z",
      "storeId": "123e4567-e89b-12d3-a456-426614174000",
      "comment": "text",
      "cancelled": true,
      "pending": true,
      "unlockedAt": "2026-07-18T16:32:29.544Z",
      "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-07-18T16:32:29.544Z",
        "rewardId": "text",
        "issuedRewardId": "text"
      },
      "value": 1,
      "externalTransferId": "text",
      "createdAt": "2026-07-18T16:32:29.544Z",
      "createdBy": "123e4567-e89b-12d3-a456-426614174000",
      "walletType": {
        "name": "text",
        "walletTypeId": "3eaea517-4336-45c0-b477-f5cc1081fcdb",
        "code": "text",
        "unitSingularName": "text",
        "unitPluralName": "text",
        "active": true,
        "isDefault": true,
        "createdAt": "2026-07-18T16:32:29.544Z",
        "limits": {
          "points": {
            "interval": {
              "type": "calendarHours",
              "value": 1
            },
            "value": 1
          },
          "pointsPerMember": {
            "interval": {
              "type": "calendarHours",
              "value": 1
            },
            "value": 1
          }
        },
        "allowNegativeBalance": true
      }
    }
  ]
}

Transfer points between members

post

Integration This method allows transferring Points between logged Member and Member which he chooses.

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

storeCodestringRequired

Store code

Body

application/json

Responses

200

Return points transfer ID.

application/json

transferIdstringOptionalExample: 00000000-0000-0000-0000-000000000000

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden.

application/json

post/api/{storeCode}/member/points

HTTPcURLJavaScriptPython

POST /api/{storeCode}/member/points HTTP/1.1
Host: openloyalty.localhost
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 92

{
  "transfer": {
    "receiver": "7239e6f7-e52e-466b-8c24-699709b64076",
    "points": 1,
    "comment": "text"
  }
}

{
  "transferId": "00000000-0000-0000-0000-000000000000"
}

Deprecated

Request member’s password reset

post

Integration This method allows sending message to the user with password reset url. Purpose of this method is to provide "Forgot password" functionality. Invoking this method will send message to the user with password reset url. If CustomerRequestedPasswordReset webhook is configured the code, code number, and member contact data will be transmitted. Use code from the webhook as a token in this endpoint. password reset

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

storeCodestringRequired

Store code

Body

application/json

usernamestringOptional

Responses

204

Success. No content.

No content

400

Bad request.

application/json

404

Not found.

application/json

post/api/{storeCode}/member/password/reset/request

HTTPcURLJavaScriptPython

POST /api/{storeCode}/member/password/reset/request HTTP/1.1
Host: openloyalty.localhost
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "username": "text"
}

No content

Deprecated

Set a new member’s password

post

Integration This method allows setting a new password after requesting a password reset.

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

storeCodestringRequired

Store code

Body

application/json

tokenstringOptional

Responses

204

Success. No content.

No content

400

Bad request.

application/json

404

Not found.

application/json

post/api/{storeCode}/member/password/reset

HTTPcURLJavaScriptPython

POST /api/{storeCode}/member/password/reset HTTP/1.1
Host: openloyalty.localhost
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "reset": {
    "plainPassword": "password"
  },
  "token": "text"
}

No content

Get logged member’s tier

get

Integration This method returns a list of active Tiers that exist 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.

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

storeCodestringRequired

Store code

Query parameters

_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

namestringOptional

Responses

200Success

application/json

400

Bad request.

application/json

403

Forbidden.

application/json

404

Not found.

application/json

get/api/{storeCode}/member/tier

HTTPcURLJavaScriptPython

GET /api/{storeCode}/member/tier HTTP/1.1
Host: openloyalty.localhost
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "levelId": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "hasPhoto": true,
      "storeCode": "text"
    }
  ]
}

Deprecated

Get logged member’s bought rewards

get

Integration This method returns a list all rewards bought by logged Member. 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

Path parameters

storeCodestringRequired

Store code

Query parameters

_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

rewardIdstringOptional

namestringOptional

tokenstringOptional

statusstringOptional

costInPointsintegerOptional

rewardTypestringOptional

redemptionDatestring · date-timeOptional

Responses

200

List of rewards bought by logged in member

application/json

400

Bad request.

application/json

403

Forbidden.

application/json

get/api/{storeCode}/member/reward/bought

HTTPcURLJavaScriptPython

GET /api/{storeCode}/member/reward/bought 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-07-18T16:32:29.544Z",
      "issuedCoupon": {
        "code": "text",
        "value": 1,
        "activeFrom": "2026-07-18T16:32:29.544Z",
        "activeTo": "2026-07-18T16:32:29.544Z",
        "valueType": "money",
        "usedAt": "2026-07-18T16:32:29.544Z"
      },
      "customerData": {
        "email": "text",
        "firstName": "text",
        "lastName": "text",
        "phone": "text",
        "loyaltyCardNumber": "text",
        "address": {}
      },
      "costInPoints": 1,
      "token": "text",
      "rewardType": "static_coupon",
      "unitsConversion": {
        "ratio": 1,
        "rounding": "up"
      },
      "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-07-18T16:32:29.544Z",
        "rewardId": "123e4567-e89b-12d3-a456-426614174000",
        "issuedRewardId": "123e4567-e89b-12d3-a456-426614174000"
      }
    }
  ]
}

Get referrals list

get

Integration This method returns a list of referrals Members 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.

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

storeCodestringRequired

Store code

Query parameters

referralIdstringOptional

referrerIdstringOptional

referrerNamestringOptional

referrerTokenstringOptional

refereeIdstringOptional

refereeNamestringOptional

createdAtstring · date-timeOptional

_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 referrals

application/json

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden.

application/json

get/api/{storeCode}/referral

HTTPcURLJavaScriptPython

GET /api/{storeCode}/referral HTTP/1.1
Host: openloyalty.localhost
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "referralId": "123e4567-e89b-12d3-a456-426614174000",
      "referrerId": "123e4567-e89b-12d3-a456-426614174000",
      "referrerName": "text",
      "referrerToken": "text",
      "refereeId": "123e4567-e89b-12d3-a456-426614174000",
      "refereeName": "text",
      "createdAt": "2026-07-18T16:32:29.544Z"
    }
  ]
}

Add the member’s password

post

Management This method allows assigning a password to a specific Member.

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

memberstringRequiredPattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|email=[a-zA-Z0-9!#$%&'\.*+\-@=?^_`{|}~;]+|phone=[0-9+]+|loyaltyCardNumber=[0-9a-zA-Z\._-]+

storeCodestringRequired

Store code

Body

application/json

plainPasswordstring · passwordRequired

Responses

204

Success. No content.

No content

400

Bad request.

application/json

403

Forbidden.

application/json

404

Not found.

application/json

post/api/{storeCode}/member/{member}/password

HTTPcURLJavaScriptPython

POST /api/{storeCode}/member/{member}/password HTTP/1.1
Host: openloyalty.localhost
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 28

{
  "plainPassword": "password"
}

No content

Check member’s activity history

get

Integration This method returns detailed information about a specific Campaign.

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

storeCodestringRequired

Store code

memberstringRequiredPattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|email=[a-zA-Z0-9!#$%&'\.*+\-@=?^_`{|}~;]+|phone=[0-9+]+|loyaltyCardNumber=[0-9a-zA-Z\._-]+

Query parameters

walletType:codestringOptional

Code of the wallet (e.g. default).

_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

Member history.

application/json

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden.

application/json

404

Not found.

application/json

get/api/{storeCode}/member/{member}/history

HTTPcURLJavaScriptPython

GET /api/{storeCode}/member/{member}/history HTTP/1.1
Host: openloyalty.localhost
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "customerId": "text",
      "type": "AssignedTransactionToCustomer",
      "accountId": "text",
      "createdAt": "2026-07-18T16:32:29.544Z",
      "flatVariables": {
        "transactionId": "text",
        "documentType": "text",
        "documentNumber": "text",
        "grossValue": 1
      }
    }
  ]
}

Create member's referral

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

Path parameters

storeCodestringRequired

Store code

memberstringRequiredPattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|email=[a-zA-Z0-9!#$%&'\.*+\-@=?^_`{|}~;]+|phone=[0-9+]+|loyaltyCardNumber=[0-9a-zA-Z\._-]+

Body

application/json

referrerIdstring · uuidRequired

Responses

204

Success. No content.

No content

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden.

application/json

404

Not found.

application/json

post/api/{storeCode}/member/{member}/referral

HTTPcURLJavaScriptPython

POST /api/{storeCode}/member/{member}/referral HTTP/1.1
Host: openloyalty.localhost
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 53

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

No content

Delete member's referral

delete

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

storeCodestringRequired

Store code

memberstringRequiredPattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|email=[a-zA-Z0-9!#$%&'\.*+\-@=?^_`{|}~;]+|phone=[0-9+]+|loyaltyCardNumber=[0-9a-zA-Z\._-]+

Responses

204

Success. No content.

No content

401

Unauthorized

application/json

403

Forbidden.

application/json

404

Not found.

application/json

delete/api/{storeCode}/member/{member}/referral

HTTPcURLJavaScriptPython

DELETE /api/{storeCode}/member/{member}/referral HTTP/1.1
Host: openloyalty.localhost
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Get all rewards available for logged in member.

get

Integration This method returns a list of all rewards available for logged Member. 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

Path parameters

storeCodestringRequired

Store code

Query parameters

_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

rewardIdstring · uuidOptional

rewardstring · enumOptionalPossible values:

activebooleanOptionalExample: true

createdAtstring · date-timeOptional

publicbooleanOptionalExample: true

fulfillmentTrackingbooleanOptionalDeprecatedExample: true

featuredbooleanOptionalExample: true

namestringOptional

shortDescriptionstringOptional

brandNamestringOptional

brandDescriptionstringOptional

levelsstringOptional

segmentsstringOptional

categoriesstringOptional

labelsstringOptional

Labels using pattern e.g. (key1;value1),(key2;value2),...

costInPointsintegerOptional

limitintegerOptional

availablebooleanOptionalExample: true

visiblebooleanOptionalExample: true

visibleFromstring · date-timeOptional

visibleTostring · date-timeOptional

activeFromstring · date-timeOptional

activeTostring · date-timeOptional

formatstring · html|rawOptional

If set to html, the descriptions will be in HTML format. Omit for raw output.

Responses

200

Get all rewards available for logged in member.

application/json

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden.

application/json

404

Not found.

application/json

get/api/{storeCode}/member/reward

HTTPcURLJavaScriptPython

GET /api/{storeCode}/member/reward HTTP/1.1
Host: openloyalty.localhost
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "reward": "text",
      "name": "text",
      "levels": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "segments": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "categories": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "brandIcon": true,
      "rewardId": "123e4567-e89b-12d3-a456-426614174000",
      "target": "level",
      "active": true,
      "costInPoints": 1,
      "activity": {
        "allTime": true
      },
      "visibility": {
        "allTime": true
      },
      "tax": 1,
      "taxPriceValue": 1,
      "price": 1,
      "labels": [
        {
          "key": "text",
          "value": "text"
        }
      ],
      "featured": true,
      "public": true,
      "photos": [
        {}
      ],
      "createdAt": "2026-07-18T16:32:29.544Z",
      "notIssuedCoupons": 1,
      "limitUsages": {
        "general": {
          "interval": {
            "type": "calendarHours"
          },
          "currentValue": 1,
          "limitValue": 1
        },
        "perMember": {
          "interval": {
            "type": "calendarHours"
          },
          "currentValue": 1,
          "limitValue": 1
        }
      },
      "translations": [
        {
          "name": "text",
          "id": 1,
          "locale": "text"
        }
      ],
      "couponGenerator": {
        "length": 1,
        "characterSet": "text"
      },
      "couponValue": 1,
      "segmentNames": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "levelNames": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "categoryNames": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "unitsConversion": {
        "ratio": 1,
        "rounding": "up"
      }
    }
  ]
}