Tiers

Fetch all tiers and corresponding benefits for the program linked to the API key used in the request.

get

Tiers represent a status level that a user can achieve based on their activity within a loyalty program. Each tier has a minimum threshold that a user must reach before being able to unlock the tier.

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/programs/tiers' \
  --header 'X-API-Key: YOUR_API_KEY'

200

500

200

{
  "tiers": [
    {
      "id": "text",
      "order": 1,
      "tier_metric_minimum_threshold": 1,
      "display_name": "text",
      "marketing_benefit_text": "text",
      "image_url": "text",
      "benefits": {
        "id": "text",
        "order": "text",
        "text": "text",
        "short_text": "text"
      }
    }
  ]
}

Successful response