Get member’s loyalty status

This method returns all the details related to a specific Member about Points, Transactions, Tier, etc.

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

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

storeCodestringRequired

Store code

Responses

200Success

application/json

firstNamestringOptional

lastNamestringOptional

customerIdstring · uuidOptional

activePointsnumber · floatOptional

transferredPointsnumber · floatOptional

earnedPointsnumber · floatOptional

spentPointsnumber · floatOptional

expiredPointsnumber · floatOptional

lockedPointsnumber · floatOptional

blockedPointsnumber · floatOptional

levelNamestringOptional

levelConditionValuenumber · floatOptional

nextLevelNamestringOptionalDeprecated

This property only shows correct data for tier sets with one condition.

nextLevelConditionValuenumber · floatOptionalDeprecated

This property only shows correct data for tier sets with one condition.

transactionsAmountToNextLevelWithoutDeliveryCostsnumber · floatOptional

transactionsAmountWithoutDeliveryCostsnumber · floatOptional

transactionsAmountToNextLevelnumber · floatOptional

averageTransactionsAmountnumber · floatOptional

averageReturnTransactionsAmountnumber · floatOptional

transactionsCountintegerOptional

returnTransactionsCountintegerOptional

transactionsAmountnumber · floatOptional

returnTransactionsAmountnumber · floatOptional

pointsToNextLevelnumber · floatOptionalDeprecated

This property only shows correct data for tier sets with one condition.

currencystringOptional

levelWillExpireInDaysintegerOptional

pointsSinceLastLevelRecalculationnumber · floatOptional

pointsRequiredToRetainLevelnumber · floatOptional

pointsExpiringNextMonthnumber · floatOptional

storeCodestringOptional

firstTransactionDatestring · date-timeOptional

lastTransactionDatestring · date-timeOptional

levelAchievementDatestring · date-timeOptional

createdAtstring · date-timeOptional

registeredAtstring · date-timeOptional

referralTokenstringOptional

401

Unauthorized

application/json

403

Forbidden.

application/json

404

Not found.

application/json

get/api/{storeCode}/member/{member}/status

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

{
  "firstName": "text",
  "lastName": "text",
  "customerId": "123e4567-e89b-12d3-a456-426614174000",
  "activePoints": 1,
  "transferredPoints": 1,
  "earnedPoints": 1,
  "spentPoints": 1,
  "expiredPoints": 1,
  "lockedPoints": 1,
  "blockedPoints": 1,
  "levelName": "text",
  "levelConditionValue": 1,
  "transactionsAmountToNextLevelWithoutDeliveryCosts": 1,
  "transactionsAmountWithoutDeliveryCosts": 1,
  "transactionsAmountToNextLevel": 1,
  "averageTransactionsAmount": 1,
  "averageReturnTransactionsAmount": 1,
  "transactionsCount": 1,
  "returnTransactionsCount": 1,
  "transactionsAmount": 1,
  "returnTransactionsAmount": 1,
  "currency": "text",
  "levelWillExpireInDays": 1,
  "pointsSinceLastLevelRecalculation": 1,
  "pointsRequiredToRetainLevel": 1,
  "tierSet": {
    "tierSetId": "text",
    "name": "text",
    "isMigrated": true
  },
  "pointsExpiringNextMonth": 1,
  "pointsExpiringBreakdown": {
    "ANY_ADDITIONAL_PROPERTY": 1
  },
  "storeCode": "text",
  "firstTransactionDate": "2026-01-01T00:00:00.000Z",
  "lastTransactionDate": "2026-01-01T00:00:00.000Z",
  "levelAchievementDate": "2026-01-01T00:00:00.000Z",
  "createdAt": "2026-01-01T00:00:00.000Z",
  "registeredAt": "2026-01-01T00:00:00.000Z",
  "referralToken": "text"
}