Skip to main content
GET
/
v1
/
inquire
/
redeemable-points
Get Redeemable Points
curl --request GET \
  --url https://vanilla-dev02-loyalty.fabric.zone/api/v1/inquire/redeemable-points \
  --header 'Authorization: Bearer <token>'
{
  "status": 200,
  "message": "Success",
  "errors": {},
  "data": [
    {
      "totalPoints": 1000
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
profileId
string
required

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

​
ehtId
integer

Entity Hierarchy Tree (EHT) ID. Either the EHT ID or the clubExternalReference must be specified along with the profileID.

​
externalReference
string

External reference number of the entity/store.

​
clubExternalReference
string

External reference number of the club.

Response

OK

Response of the Get Redeemable Points endpoint

​
status
integer

Status of the call

Example:

200

​
message
string
default:Exception message

Message corresponding to the call

Example:

"Success"

​
errors
object

Error details, if applicable

Example:
{}
​
data
Data · object[]