Endpoints
Get Account
Endpoints
Get Account
This endpoint allows the retrieval of a user account information, including the user's rewards.
GET
/account
Bearer*
curl --request GET \
--url https://api.thanx.com/account \
--header 'Authorization: Bearer <token>'Parameters
location_uid
string
The location identifier; this is what your system uses to identify a location. Providing this information allows Thanx to return rewards that can be used at this location.
Response
id
string
The ID of the tier status record
email
string
The user’s email
rewards
array(hash)
The user’s rewards for the merchant specified in the header. This array can be empty.
points_products
array(hash)
The merchant’s configured points product available for online redemption. This array can be empty.
progress
hash
A user’s progress toward their next loyalty reward
Only present for merchants that have not yet upgraded to points
points
array
Array of information about the configured points experiences and the current user’s balance at each
Only present for merchants that have enabled points
curl https://loyalty.thanxsandbox.com/api/account?location_uid=8bda69 \
-H "Authorization: Bearer 945148251b603ae34561d90acfe4050e67494d6d1e65d4d3d52798407f03c0bd" \
-H "Content-Type: application/json" \
-H "Accept: application/vnd.thanx-v1+json" \
-H "Merchant-Key: cb71e3"
{
"id": "wer23gtTT",
"email": "john.smith@example.com.com",
"rewards": [
{
"id": "gheTfR",
"value": 10,
"minimum": 20,
"maximum": 20,
"label": "A free hamburger",
"state": "redeemable",
"type": "amount",
"products": ["234234-23423423", "3458-345345"],
"fine_print": "Reward fine print",
"retire_at": "2020-05-01T20:00:00Z"
}
],
"points_products": [
{
"id": "9xw6543wh8jmde0",
"points_experience_id": "590485d6f0",
"points": 10,
"value": 10,
"minimum": 20,
"maximum": 20,
"label": "Onion rings",
"state": "redeemable",
"products": ["234234-23423423", "3458-345345"],
"fine_print": "Points product fine print",
}
],
"progress": {
"percentage": 20,
"towards": "$5 off next purchase"
},
"points": [
{
"points_experience_id": "590485d6f0",
"currency": {
"name": "Star",
"plural": "Stars"
},
"balance": 10.0
}
]
}
curl https://loyalty.thanxsandbox.com/api/account?location_uid=8bda69 \
-H "Authorization: Bearer 945148251b603ae34561d90acfe4050e67494d6d1e65d4d3d52798407f03c0bd" \
-H "Content-Type: application/json" \
-H "Accept: application/vnd.thanx-v1+json" \
-H "Merchant-Key: cb71e3"
{
"id": "wer23gtTT",
"email": "john.smith@example.com.com",
"rewards": [
{
"id": "gheTfR",
"value": 10,
"minimum": 20,
"maximum": 20,
"label": "A free hamburger",
"state": "redeemable",
"type": "amount",
"products": ["234234-23423423", "3458-345345"],
"fine_print": "Reward fine print",
"retire_at": "2020-05-01T20:00:00Z"
}
],
"points_products": [
{
"id": "9xw6543wh8jmde0",
"points_experience_id": "590485d6f0",
"points": 10,
"value": 10,
"minimum": 20,
"maximum": 20,
"label": "Onion rings",
"state": "redeemable",
"products": ["234234-23423423", "3458-345345"],
"fine_print": "Points product fine print",
}
],
"progress": {
"percentage": 20,
"towards": "$5 off next purchase"
},
"points": [
{
"points_experience_id": "590485d6f0",
"currency": {
"name": "Star",
"plural": "Stars"
},
"balance": 10.0
}
]
}