Get tier’s details

Management This method returns a specific Tier from the system.

Deprecated

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

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}

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-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"
    }
  ],
  "sortOrder": 1,
  "isDefault": true,
  "translations": [
    {
      "id": 1,
      "name": "text",
      "description": "text",
      "locale": "text"
    }
  ],
  "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"
}