Skip to main content
GET
/
api
/
account
curl https://loyalty.thanxsandbox.com/api/account \
  -H "Authorization: Bearer ${token}" \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.thanx-v1+json" \
  -H "Merchant-Key: ${merchant_key}" \
  -G \
  --data-urlencode "location_id=${location_id}" \
  --data-urlencode "redemption_venue=online" \
  --data-urlencode "reward_states[]=delivered" \
  --data-urlencode "reward_states[]=active"

{
  "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",
      "restriction_location_ids": ["a", "b"]
    }
  ],
  "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",
      "restriction_location_ids": ["a", "b"]
    }
  ],
  "progress": {
    "percentage": 20,
    "towards": "$5 off next purchase"
  },
  "points": [
    {
      "points_experience_id": "590485d6f0",
      "currency": {
        "name": "Star",
        "plural": "Stars"
      },
      "balance": 10.0
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.thanx.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Parameters

​
location_id
string
Thanx Location UID. Providing this information allows Thanx to return rewards that can be used at this location.A mapping of Thanx location identifiers can be provided by the Thanx developer support team or fetched from the following endpoints depending on your integration type:
​
redemption_venue
string
Currently either instore or online, defaults to online. This is used to adjust which configured product IDs are returned in the applicable reward and points product entities.
​
reward_states
array
Filter rewards by state. Valid values: delivered, active. Defaults to delivered if not provided. Multiple states can be specified to return rewards matching any of the specified states.

​
Response

​
id
string
The ID of user
​
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 \
  -H "Authorization: Bearer ${token}" \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.thanx-v1+json" \
  -H "Merchant-Key: ${merchant_key}" \
  -G \
  --data-urlencode "location_id=${location_id}" \
  --data-urlencode "redemption_venue=online" \
  --data-urlencode "reward_states[]=delivered" \
  --data-urlencode "reward_states[]=active"

{
  "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",
      "restriction_location_ids": ["a", "b"]
    }
  ],
  "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",
      "restriction_location_ids": ["a", "b"]
    }
  ],
  "progress": {
    "percentage": 20,
    "towards": "$5 off next purchase"
  },
  "points": [
    {
      "points_experience_id": "590485d6f0",
      "currency": {
        "name": "Star",
        "plural": "Stars"
      },
      "balance": 10.0
    }
  ]
}