Skip to main content
GET
/
v1
/
inquire
/
{profileId}
/
member-points
Get Member Points
curl --request GET \
  --url https://vanilla-dev02-loyalty.fabric.zone/api/v1/inquire/{profileId}/member-points \
  --header 'Authorization: Bearer <token>'
{
  "status": 200,
  "message": "",
  "errors": {},
  "data": [
    {
      "totalPoints": 300,
      "pointsByType": [
        {
          "pointType": "Base",
          "points": 300,
          "subType": null
        }
      ],
      "pointsBalance": {
        "memberPointsEarned": 600,
        "memberPointsDeducted": 100,
        "memberPointsUsed": 100,
        "memberPointsExpired": 100,
        "memberPointsAvailable": 300,
        "memberPointsLocked": 100
      },
      "breakdown": {
        "totalPoints": 300,
        "totalCurrencyValue": 150,
        "unrestrictedPoints": {
          "totalPoints": 200,
          "totalCurrencyValue": 100,
          "unrestrictedPointsItems": [
            {
              "points": 200,
              "pointType": "Base"
            }
          ]
        },
        "restrictedPoints": {
          "totalPoints": 100,
          "totalCurrencyValue": 50,
          "restrictedPointsItems": [
            {
              "points": 100,
              "pointType": "Base",
              "restrictedLocation": "4321"
            }
          ]
        }
      }
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
profileId
string
required

Profile ID. It is generated in the response of the Enroll Member endpoint - POST /v1/members.

Response

OK

Response of the Get Member Points endpoint

​
status
integer

Status of the call

Example:

200

​
message
string
default:Exception message

Message corresponding to the call

Example:

""

​
errors
object

Error details, if applicable

Example:
{}
​
data
Data · object[]