Tier

These endpoints will allow you to easily manage tiers.

Deprecated

Get tier’s details

get

Management This method returns a specific Tier from 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

tierstring · uuidRequired

Tier ID

Responses

200

Tier details.

application/json

levelIdstring · uuidRequired

This field show tier id

namestringRequired

This field show tier name

descriptionstringOptional

This field show tier description

hasPhotobooleanRequired

This field show if tier have photo

storeCodestringRequired

The field shows what store tier it is in

activebooleanRequired

The field shows whether the tier is active

sortOrdernumberRequired

This field shows order of tiers, the higher the number, the higher the tier.

isDefaultbooleanRequired

This field shows whether the tier is the default tier that was created automatically along with the tier set. Tier serves as the starting tier in tie set

createdAtstring · date-timeRequired

tier created at date

updatedAtstring · date-timeRequired

tier updated at date

createdBystring · uuidOptional

tier created by

updatedBystring · uuidOptional

tier updated by

conditionValuenumber · floatOptionalDeprecated

401

Unauthorized

application/json

403

Forbidden.

application/json

404

Not found.

application/json

get/api/{storeCode}/tier/{tier}

HTTPcURLJavaScriptPython

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

{
  "levelId": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "hasPhoto": true,
  "storeCode": "text",
  "tierSet": {
    "tierSetId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text"
  },
  "conditions": [
    {
      "conditionId": "123e4567-e89b-12d3-a456-426614174000",
      "attribute": "activeUnits",
      "value": "text"
    }
  ],
  "active": true,
  "rewards": [
    {
      "rewardId": {
        "rewardId": "123e4567-e89b-12d3-a456-426614174000"
      },
      "name": "text",
      "value": 1,
      "code": "text",
      "labels": [
        {
          "key": "text",
          "value": "text"
        }
      ],
      "active": true,
      "startAt": "2026-07-18T16:30:56.234Z",
      "endAt": "2026-07-18T16:30:56.234Z",
      "createdAt": "2026-07-18T16:30:56.234Z",
      "updatedAt": "2026-07-18T16:30:56.234Z",
      "createdBy": "123e4567-e89b-12d3-a456-426614174000",
      "updatedBy": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "sortOrder": 1,
  "isDefault": true,
  "translations": [
    {
      "id": 1,
      "name": "text",
      "description": "text",
      "locale": "text"
    }
  ],
  "createdAt": "2026-07-18T16:30:56.234Z",
  "updatedAt": "2026-07-18T16:30:56.234Z",
  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
  "updatedBy": "123e4567-e89b-12d3-a456-426614174000"
}

Deprecated

Update tier’s details

put

This method allows updating a specific Tier 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

tierstring · uuidRequired

Tier ID

Body

application/json

Responses

200

Return updated tier ID.

application/json

levelIdstringOptional

Updated tier identity

Example: 00000000-0000-0000-0000-000000000000

400

Bad request.

application/json

403

Forbidden.

application/json

404

Not found.

application/json

put/api/{storeCode}/tier/{tier}

HTTPcURLJavaScriptPython

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

{
  "level": {
    "translations": {
      "en": {
        "name": "text",
        "description": "text"
      },
      "pl": {
        "name": "text",
        "description": "text"
      }
    },
    "active": true,
    "conditionValue": 1,
    "rewards": [
      {
        "name": "text",
        "value": 1,
        "code": "text",
        "active": true,
        "startAt": "2026-07-18",
        "endAt": "2026-07-18",
        "labels": [
          {
            "key": "text",
            "value": "text"
          }
        ]
      }
    ]
  }
}

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

Deprecated

Delete a tier

delete

Management This method allows removing a specific Tier from 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

tierstring · uuidRequired

Tier ID

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

delete/api/{storeCode}/tier/{tier}

HTTPcURLJavaScriptPython

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

No content

Get tier's photo

get

Management This method returns a photo added to a specific 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

tierstring · uuidRequired

Tier ID

Responses

200

Returned when successful.

image/*

string · binaryOptional

302

Redirect to presigned URL when presigned URLs are enabled.

403

Forbidden.

application/json

404

Not found.

application/json

get/api/{storeCode}/tier/{tier}/photo

HTTPcURLJavaScriptPython

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

binary

Add a tier’s photo

post

Management This method allows adding a photo to a specific 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

tierstring · uuidRequired

Tier ID

Body

application/json

Responses

200

Returned when successful

No content

400

Bad request.

application/json

403

Forbidden.

application/json

404

Not found.

application/json

post/api/{storeCode}/tier/{tier}/photo

HTTPcURLJavaScriptPython

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

{
  "photo": {
    "file": {}
  }
}

No content

Delete tier’s photo

delete

Management This method allows removing a photo from a specific 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

tierstring · uuidRequired

Tier ID

Responses

200

Returned when successful

No content

400

Bad request.

application/json

403

Forbidden.

application/json

404

Not found.

application/json

delete/api/{storeCode}/tier/{tier}/photo

HTTPcURLJavaScriptPython

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

No content

Deprecated

Export tier’s members list

get

This method returns a file with all Members assigned to a specific 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

tierstring · uuidRequired

Tier ID

Responses

200Success

text/csv

stringOptional

403

Forbidden.

application/json

404

Not found.

application/json

get/api/{storeCode}/tier/{tier}/export

HTTPcURLJavaScriptPython

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

text

Deprecated

Add a tier

post

This method allows adding a new Tier to 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

Body

application/json

Responses

200

Return created tier ID.

application/json

levelIdstringOptional

Created tier identity

Example: 00000000-0000-0000-0000-000000000000

400

Bad request.

application/json

403

Forbidden.

application/json

post/api/{storeCode}/tier/create

HTTPcURLJavaScriptPython

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

{
  "level": {
    "translations": {
      "en": {
        "name": "text",
        "description": "text"
      },
      "pl": {
        "name": "text",
        "description": "text"
      }
    },
    "active": true,
    "conditionValue": 1,
    "rewards": [
      {
        "name": "text",
        "value": 1,
        "code": "text",
        "active": true,
        "startAt": "2026-07-18",
        "endAt": "2026-07-18",
        "labels": [
          {
            "key": "text",
            "value": "text"
          }
        ]
      }
    ]
  }
}

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

Activate a tier

post

Management This method allows activating a specific 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

tierstring · uuidRequired

Tier ID

Body

application/json

activebooleanRequired

If the tier should be active

Responses

200

Returned when successful

No content

400

Bad request.

application/json

403

Forbidden.

application/json

404

Not found.

application/json

post/api/{storeCode}/tier/{tier}/activate

HTTPcURLJavaScriptPython

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

{
  "active": true
}

No content

Get tier sets list

get

Management This method returns a list of all created TierSets in the system. Currently, it returns one available tierSet, but in the future, if the multi-tier sets created, it will return a list of all tierSets from the specific tenant (storeCode).

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

namestringOptional

activebooleanOptional

Filter by active filed

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

Tier set list.

application/json

401

Unauthorized

application/json

403

Forbidden.

application/json

get/api/{storeCode}/tierSet

HTTPcURLJavaScriptPython

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

{
  "items": [
    {
      "tierSetId": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "active": true,
      "createdAt": "2026-07-18T16:30:56.234Z",
      "updatedAt": "2026-07-18T16:30:56.234Z",
      "labels": [
        {
          "key": "text",
          "value": "text"
        }
      ],
      "conditions": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "attribute": "activeUnits",
          "walletType": "default"
        }
      ],
      "tiers": [
        {
          "levelId": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "description": "text",
          "active": null
        }
      ],
      "translations": {
        "en": {
          "name": "text",
          "description": "text"
        },
        "pl": {
          "name": "text",
          "description": "text"
        }
      },
      "isMigrated": true,
      "isDefault": true,
      "downgrade": {
        "mode": "none",
        "period": "registration_anniversary",
        "recalculationDates": [
          "03-10"
        ],
        "interval": 2
      }
    }
  ]
}

Add a tier set

post

Management This method allows adding a new TierSet to 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

Body

application/json

Responses

200

Successfully created tier set .

application/json

tierSetIdstring · uuidOptional

Created tierSet identity

Example: 00000000-0000-0000-0000-000000000000

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden.

application/json

post/api/{storeCode}/tierSet

HTTPcURLJavaScriptPython

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

{
  "tierSet": {
    "translations": {
      "en": {
        "name": "Gold tier set"
      }
    },
    "active": false,
    "conditions": [
      {
        "attribute": "monthsSinceJoiningProgram"
      }
    ],
    "downgrade": {
      "mode": "none"
    }
  }
}

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

Return tier set member progress.

get

This method returns detailed member progress information for a specific tier set

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\._-]+

tierSetstring · uuidRequired

TierSet ID

Responses

200

Tier set member progress.

application/json

currentTierIdstring · uuidOptional

The field displays the member's current tier id

currentTierNamestringOptional

The field displays the member's current tier name

nextTierIdstring · uuidOptional

The field displays the member's next tier id

nextTierNamestringOptional

The field displays the member's next tier name

tierSetIdstring · uuidRequired

The field will show the tierSet id in which the tier is located

tierSetNamestringRequired

The field will show the tierSet id in which the tier is located

currentProgressnumber · doubleOptional

Shows you your current progress percentage and what progress you are missing to reach the next tier

lastPromotionAtstring · date-timeOptional

Shows when the last promotion to a higher tier occurred

lastDowngradeAtstring · date-timeOptional

Shows when the last downgrade to a lower tier occurred

nextRecalculationAtstring · date-timeOptional

Shows the date of the next recalculation

manuallybooleanRequired

Shows whether the current tier has been assigned manually

downgradestringRequired

Shows downgrade mode

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden.

application/json

404

Not found.

application/json

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

HTTPcURLJavaScriptPython

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

{
  "currentTierId": "123e4567-e89b-12d3-a456-426614174000",
  "currentTierName": "text",
  "nextTierId": "123e4567-e89b-12d3-a456-426614174000",
  "nextTierName": "text",
  "tierSetId": "123e4567-e89b-12d3-a456-426614174000",
  "tierSetName": "text",
  "currentProgress": 1,
  "lastPromotionAt": "2026-07-18T16:30:56.234Z",
  "lastDowngradeAt": "2026-07-18T16:30:56.234Z",
  "nextRecalculationAt": "2026-07-18T16:30:56.234Z",
  "manually": true,
  "downgrade": "text",
  "nextTierCurrentProgress": [
    {
      "conditionId": "123e4567-e89b-12d3-a456-426614174000",
      "attribute": "activeUnits",
      "currentValue": 1,
      "valueGoal": 1,
      "walletType": "text"
    }
  ]
}

Deprecated

Get tiers list

get

This method returns a list of all created Tiers 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

levelIdstringOptional

conditionValuenumberOptional

namestringOptional

descriptionstringOptional

activebooleanOptional

Filter by active filed

reward:namestringOptional

reward:codestringOptional

reward:valuenumberOptional

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

application/json

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden.

application/json

404

Not found.

application/json

get/api/{storeCode}/tier

HTTPcURLJavaScriptPython

GET /api/{storeCode}/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",
      "tierSet": {
        "tierSetId": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text"
      },
      "conditions": [
        {
          "conditionId": "123e4567-e89b-12d3-a456-426614174000",
          "attribute": "activeUnits",
          "value": "text"
        }
      ],
      "active": true,
      "rewards": [
        {
          "rewardId": {
            "rewardId": "123e4567-e89b-12d3-a456-426614174000"
          },
          "name": "text",
          "value": 1,
          "code": "text",
          "labels": [
            {
              "key": "text",
              "value": "text"
            }
          ],
          "active": true,
          "startAt": "2026-07-18T16:30:56.234Z",
          "endAt": "2026-07-18T16:30:56.234Z",
          "createdAt": "2026-07-18T16:30:56.234Z",
          "updatedAt": "2026-07-18T16:30:56.234Z",
          "createdBy": "123e4567-e89b-12d3-a456-426614174000",
          "updatedBy": "123e4567-e89b-12d3-a456-426614174000"
        }
      ],
      "sortOrder": 1,
      "isDefault": true,
      "translations": [
        {
          "id": 1,
          "name": "text",
          "description": "text",
          "locale": "text"
        }
      ],
      "createdAt": "2026-07-18T16:30:56.234Z",
      "updatedAt": "2026-07-18T16:30:56.234Z",
      "createdBy": "123e4567-e89b-12d3-a456-426614174000",
      "updatedBy": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}

Get list of tier sets which member is assigned

get

Returns the list of tier sets that the specified member is assigned to.

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

currentTierIdstringOptional

Filter by current tier id field

tierSetIdstringOptional

Filter by tier set Id field

Responses

200

List of member tier sets.

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}/tierSet

HTTPcURLJavaScriptPython

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

{
  "items": [
    {
      "currentTierId": "123e4567-e89b-12d3-a456-426614174000",
      "tierSetId": "123e4567-e89b-12d3-a456-426614174000",
      "tierSetName": "text",
      "currentTierName": "text",
      "manually": true
    }
  ]
}

Get tier set’s details

get

Management

Authorizations

Bearertoken

AuthorizationstringRequired

Open Loyalty has the JWT authorization. To learn what a JSON Web Token is and how it works, check out Introduction to JSON Web Tokens https://jwt.io/introduction/

Obtain an access token

Send a request with the parameters username and password

Definition

POST /api/admin/login_check Go to definition
POST /api/{storeCode}/member/login_check Go to definition

Example

curl {HOST}/api/admin/login_check
    -H 'Content-Type: application/json;charset=UTF-8'
    -H 'Accept: application/json, text/plain, */*'
    --data-binary '{"username":"admin","password":"password"}'

Example Response

{
    "token":"eyJhbGciOiJSUzI1NiIsInR5cCI6...",
    "refresh_token":"0558f8bb29948c4e54c443f..."
}

Using JSON Web Token

Add authorization header to each request
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6...
You can now access any API method you want under the /api prefix.

Example

curl {HOST}/api/{storeCode}/analytics/members
    -H 'Accept: application/json'
    -H 'Content-type: application/x-www-form-urlencoded'
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6...'

Refresh JSON Web Token

You can refresh token using refresh_token that was given during login.
There are two endpoints
To refresh admin token POST /api/token/refresh Go to definition
To refresh member token POST /api/{storeCode}/token/refresh Go to definition

Path parameters

storeCodestringRequired

Store code

tierSetstring · uuidRequired

TierSet ID

Responses

200

Tier set details

application/json

tierSetIdstring · uuidRequired

Tier set name id.

namestringRequired

Tier set name.

descriptionstringOptional

Tier set description.

activebooleanOptional

The filed shows if tier set is active.

createdAtstring · date-timeRequired

Tier set created at date.

updatedAtstring · date-timeRequired

Tier set updated at date.

isMigratedbooleanRequired

This field shows whether the tier set has been migrated from the old tier system

isDefaultbooleanRequired

This field shows which tier set was added first, which means that the tier set is default

401

Unauthorized

application/json

403

Forbidden.

application/json

404

Not found.

application/json

get/api/{storeCode}/tierSet/{tierSet}

HTTPcURLJavaScriptPython

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

{
  "tierSetId": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "active": true,
  "createdAt": "2026-07-18T16:30:56.234Z",
  "updatedAt": "2026-07-18T16:30:56.234Z",
  "labels": [
    {
      "key": "text",
      "value": "text"
    }
  ],
  "conditions": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "attribute": "activeUnits",
      "walletType": "text"
    }
  ],
  "tiers": [
    {
      "levelId": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "active": null
    }
  ],
  "translations": {
    "en": {
      "name": "text",
      "description": "text"
    },
    "pl": {
      "name": "text",
      "description": "text"
    }
  },
  "isMigrated": true,
  "isDefault": true,
  "downgrade": {
    "mode": "none",
    "period": "registration_anniversary",
    "recalculationDates": [
      "03-10"
    ],
    "interval": 2
  }
}

Update a tier set

put

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

tierSetstring · uuidRequired

TierSet ID

Body

application/json

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

put/api/{storeCode}/tierSet/{tierSet}

HTTPcURLJavaScriptPython

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

{
  "tierSet": {
    "translations": {
      "en": {
        "name": "Gold tier set"
      }
    },
    "active": false,
    "conditions": [
      {
        "attribute": "monthsSinceJoiningProgram"
      }
    ],
    "downgrade": {
      "mode": "none"
    }
  }
}

No content

Get tiers list from a tier set

get

Management

Authorizations

Bearertoken

AuthorizationstringRequired

Open Loyalty has the JWT authorization. To learn what a JSON Web Token is and how it works, check out Introduction to JSON Web Tokens https://jwt.io/introduction/

Obtain an access token

Send a request with the parameters username and password

Definition

POST /api/admin/login_check Go to definition
POST /api/{storeCode}/member/login_check Go to definition

Example

curl {HOST}/api/admin/login_check
    -H 'Content-Type: application/json;charset=UTF-8'
    -H 'Accept: application/json, text/plain, */*'
    --data-binary '{"username":"admin","password":"password"}'

Example Response

{
    "token":"eyJhbGciOiJSUzI1NiIsInR5cCI6...",
    "refresh_token":"0558f8bb29948c4e54c443f..."
}

Using JSON Web Token

Add authorization header to each request
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6...
You can now access any API method you want under the /api prefix.

Example

curl {HOST}/api/{storeCode}/analytics/members
    -H 'Accept: application/json'
    -H 'Content-type: application/x-www-form-urlencoded'
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6...'

Refresh JSON Web Token

You can refresh token using refresh_token that was given during login.
There are two endpoints
To refresh admin token POST /api/token/refresh Go to definition
To refresh member token POST /api/{storeCode}/token/refresh Go to definition

Path parameters

storeCodestringRequired

Store code

tierSetstring · uuidRequired

TierSet ID

Query parameters

namestringOptional

activebooleanOptional

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

Tiers list

application/json

401

Unauthorized

application/json

403

Forbidden.

application/json

get/api/{storeCode}/tierSet/{tierSet}/tiers

HTTPcURLJavaScriptPython

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

{
  "items": [
    {
      "levelId": "123e4567-e89b-12d3-a456-426614174000",
      "tierSet": {
        "tierSetId": {
          "tierSetId": "123e4567-e89b-12d3-a456-426614174000"
        },
        "name": "text"
      },
      "name": "text",
      "description": "text",
      "storeCode": "text",
      "active": true,
      "rewards": [
        {
          "rewardId": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "value": 1,
          "code": "text",
          "labels": [
            {
              "key": "text",
              "value": "text"
            }
          ],
          "active": true,
          "startAt": "2026-07-18T16:30:56.234Z",
          "endAt": "2026-07-18T16:30:56.234Z",
          "createdAt": "2026-07-18T16:30:56.234Z",
          "updatedAt": "2026-07-18T16:30:56.234Z",
          "createdBy": "123e4567-e89b-12d3-a456-426614174000",
          "updatedBy": "123e4567-e89b-12d3-a456-426614174000"
        }
      ],
      "conditions": [
        {
          "conditionId": "123e4567-e89b-12d3-a456-426614174000",
          "attribute": "activeUnits",
          "value": 1
        }
      ],
      "translations": {
        "en": {
          "name": "text",
          "description": "text"
        },
        "pl": {
          "name": "text",
          "description": "text"
        }
      },
      "createdAt": "2026-07-18T16:30:56.234Z",
      "updatedAt": "2026-07-18T16:30:56.234Z",
      "hasPhoto": true,
      "isDefault": true
    }
  ]
}

Update existing tier list with conditions

put

Management Method allows to edit existing tier list with conditions.

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

tierSetstring · uuidRequired

TierSet ID

Body

application/json

Responses

204

Success. No content.

No content

400

Bad request.

application/json

403

Forbidden.

application/json

404

Not found.

application/json

put/api/{storeCode}/tierSet/{tierSet}/tiers

HTTPcURLJavaScriptPython

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

{
  "tiers": [
    {
      "levelId": "123e4567-e89b-12d3-a456-426614174000",
      "translations": {
        "en": {
          "name": "text",
          "description": "text"
        },
        "pl": {
          "name": "text",
          "description": "text"
        }
      },
      "active": true,
      "conditions": [
        {
          "conditionId": "123e4567-e89b-12d3-a456-426614174000",
          "value": 1
        }
      ],
      "rewards": [
        {
          "rewardId": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "value": 1,
          "code": "text",
          "labels": [
            {
              "key": "text",
              "value": "text"
            }
          ],
          "active": true,
          "startAt": "2026-07-18T16:30:56.234Z",
          "endAt": "2026-07-18T16:30:56.234Z"
        }
      ]
    }
  ]
}

No content