Return tier set member progress.

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

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

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}

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-01-01T00:00:00.000Z",
  "lastDowngradeAt": "2026-01-01T00:00:00.000Z",
  "nextRecalculationAt": "2026-01-01T00:00:00.000Z",
  "manually": true,
  "downgrade": "text",
  "nextTierCurrentProgress": [
    {
      "conditionId": "123e4567-e89b-12d3-a456-426614174000",
      "attribute": "activeUnits",
      "currentValue": 1,
      "valueGoal": 1,
      "walletType": "text"
    }
  ]
}