Get tier set’s details

Management

get

Authorizations

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}

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-01-01T00:00:00.000Z",
  "updatedAt": "2026-01-01T00:00:00.000Z",
  "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
  }
}