Get tiers list from a tier set

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

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

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-01-01T00:00:00.000Z",
          "endAt": "2026-01-01T00:00:00.000Z",
          "createdAt": "2026-01-01T00:00:00.000Z",
          "updatedAt": "2026-01-01T00:00:00.000Z",
          "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-01-01T00:00:00.000Z",
      "updatedAt": "2026-01-01T00:00:00.000Z",
      "hasPhoto": true,
      "isDefault": true
    }
  ]
}