Skip to main content
GET
/
headless
/
2025-06
/
{site_id}
/
configuration
cURL
curl --request GET \
  --url https://api.loyaltylion.com/headless/2025-06/{site_id}/configuration \
  --header 'Authorization: Bearer <token>'
{
  "channel": "web",
  "currency": "usd",
  "language": "en",
  "program": {
    "name": "Lion Rewards"
  },
  "tier_configuration": {
    "boundary_mode": "spend",
    "tiers": [
      {
        "id": 1,
        "name": "Silver",
        "benefit_ids": [
          1
        ],
        "hidden": false,
        "kind": "spend",
        "position": 1,
        "lower_bound": {
          "amount": 0,
          "formatted": "$0"
        },
        "upper_bound": {
          "amount": 99.99,
          "formatted": "$99.99"
        }
      },
      {
        "id": 2,
        "name": "Gold",
        "benefit_ids": [
          1,
          2
        ],
        "hidden": false,
        "kind": "spend",
        "position": 2,
        "lower_bound": {
          "amount": 100,
          "formatted": "$100"
        },
        "upper_bound": null
      }
    ],
    "tier_benefits": [
      {
        "id": 1,
        "label": "Early access to new products",
        "secret": false,
        "details": null
      },
      {
        "id": 2,
        "label": "Free makeup classes",
        "secret": false,
        "details": {
          "plaintext": "Email [email protected] to sign up to a class\n",
          "html": "<p>Email [email protected] to sign up to a class</p>"
        }
      }
    ],
    "membership": {
      "mode": "rolling",
      "duration_months": 12
    }
  },
  "referee_incentive": {
    "minimum_spend": {
      "amount": 100,
      "formatted": "$100"
    },
    "incentive_text": "Get a 10% discount on your order with this code when you spend over $100",
    "kind": "cart_discount_voucher",
    "discount_kind": "percentage",
    "discount": {
      "percentage": 10,
      "formatted": "10%"
    }
  },
  "rules": [
    {
      "id": 1,
      "kind": "purchase",
      "variants": [
        {
          "tier_id": 1,
          "enabled": true,
          "title": "Make a purchase",
          "result": {
            "kind": "points",
            "per_currency_unit": 1,
            "points": 5
          },
          "result_short_text": "5 points per $1"
        },
        {
          "tier_id": 2,
          "enabled": true,
          "title": "Make a purchase",
          "result": {
            "kind": "points",
            "per_currency_unit": 1,
            "points": 10
          },
          "result_short_text": "10 points per $1"
        }
      ],
      "limit": null
    },
    {
      "id": 2,
      "kind": "pageview",
      "variants": [
        {
          "tier_id": 1,
          "enabled": true,
          "title": "Visit our online store",
          "result": {
            "kind": "points",
            "per_currency_unit": null,
            "points": 100
          },
          "result_short_text": "100 points"
        },
        {
          "tier_id": 2,
          "enabled": true,
          "title": "Visit our online store",
          "result": {
            "kind": "points",
            "per_currency_unit": null,
            "points": 200
          },
          "result_short_text": "200 points"
        }
      ],
      "limit": {
        "count": 1,
        "interval": "week"
      }
    }
  ],
  "rewards": [
    {
      "id": 1,
      "kind": "cart_discount_voucher",
      "properties": {
        "discount_type": "fixed",
        "discount": {
          "amount": 5,
          "formatted": "$5"
        },
        "applies_to_order_type": "one_time",
        "recurring_cycle_limit": 1,
        "supports_active_subscriptions": false,
        "minimum_spend": {
          "amount": 10,
          "formatted": "$10"
        }
      },
      "variants": [
        {
          "tier_id": 1,
          "enabled": true,
          "title": "$5 discount",
          "cost": {
            "kind": "fixed",
            "points": 500
          },
          "cost_text": "500 points"
        },
        {
          "tier_id": 2,
          "enabled": true,
          "title": "$5 discount",
          "cost": {
            "kind": "fixed",
            "points": 400
          },
          "cost_text": "400 points"
        }
      ],
      "limit": null
    },
    {
      "id": 2,
      "kind": "cart_variable_discount_voucher",
      "properties": {
        "minimum_discount": {
          "amount": 1,
          "formatted": "$1"
        },
        "maximum_discount": {
          "amount": 100,
          "formatted": "$100"
        },
        "applies_to_order_type": "all",
        "minimum_spend_before_discount": null,
        "minimum_spend_after_discount": null
      },
      "variants": [
        {
          "tier_id": 1,
          "enabled": false,
          "title": "Redeem points at checkout",
          "cost": {
            "kind": "variable",
            "unit": "discount_amount",
            "points_per_unit": 100
          },
          "cost_text": "100 points per $1"
        },
        {
          "tier_id": 2,
          "enabled": true,
          "title": "Redeem points at checkout",
          "cost": {
            "kind": "variable",
            "unit": "discount_amount",
            "points_per_unit": 100
          },
          "cost_text": "100 points per $1"
        }
      ],
      "limit": null
    }
  ]
}
Use this endpoint to retrieve the full configuration for a site, based on the requested sales channel. This configuration includes tier details, rules, rewards and various other settings that can be used to construct a custom shopper-facing frontend.
This endpoint has a rate limit of 100 requests per secondIf you anticipate making a high volume of calls to this endpoint, e.g. if you are calling it on each page render, consider caching the returned configuration for a short period (max 30 seconds) and reusing it

Authorizations

​
Authorization
string
header
required

An API key linked to a Program in LoyaltyLion, with a set of permissions (scopes). API keys can be created manually, or acquired through an OAuth2 flow. The API key should be provided as a Bearer token in the Authorization header

Path Parameters

​
site_id
number
required

Your LoyaltyLion Site ID

Query Parameters

​
channel
enum<string>

The sales channel from which this request is made

Available options:
web,
pos,
mobile

Response

200

​
channel
enum<string>
required

The sales channel for which this response was generated

Available options:
web,
pos,
mobile
​
currency
string
required

ISO 4217 code indicating the currency for any financial values in this response

Example:

"usd"

​
language
string
required

ISO 639-1 code indicating the language used for any text in this response

​
program
object
required
​
tier_configuration
object
required

The tier configuration for the program, or null if tiers are not enabled

Example:
{
  "boundary_mode": "spend",
  "tiers": [
    {
      "id": 1,
      "name": "Silver",
      "benefit_ids": [1],
      "hidden": false,
      "kind": "spend",
      "position": 1,
      "lower_bound": { "amount": 0, "formatted": "$0" },
      "upper_bound": { "amount": 99.99, "formatted": "$99.99" }
    },
    {
      "id": 2,
      "name": "Gold",
      "benefit_ids": [1, 2],
      "hidden": false,
      "kind": "spend",
      "position": 2,
      "lower_bound": { "amount": 100, "formatted": "$100" },
      "upper_bound": null
    }
  ],
  "tier_benefits": [
    {
      "id": 1,
      "label": "Early access to new products",
      "secret": false,
      "details": null
    },
    {
      "id": 2,
      "label": "Free makeup classes",
      "secret": false,
      "details": {
        "plaintext": "Email [email protected] to sign up to a class\n",
        "html": "<p>Email [email protected] to sign up to a class</p>"
      }
    }
  ],
  "membership": { "mode": "rolling", "duration_months": 12 }
}
​
rules
(Birthday · object | Collection purchase · object | Newsletter signup · object | Pageview · object | Product purchase · object | Purchase · object | Join program · object | Review · object | Custom · object | Facebook Like · object | Twitter follow · object | Instagram follow · object | Instagram mention · object | Instagram post hashtag · object | Tiktok follow · object | Tiktok post hashtag · object | Referral · object | Clickthrough · object)[]
required

Ordered list of rules that belong to this site. Each rule will have one or more variants that indicate its configuration and if it is enabled per tier. Rules have a kind property, and some kinds of rules will have properties that are specific to that rule kind

​
rewards
(Gift card · object | Cart discount voucher · object | Cart variable discount · object | Free shipping voucher · object | Product discount voucher · object | Collection discount voucher · object | Product cart · object | Active subscription discount voucher · object | Active subscription product · object | Custom · object)[]
required

Ordered list of rewards that belong to this site. Each reward will have one or more variants that indicate its configuration and if it is enabled per tier. Rewards have a kind property, and some kinds of rewards will have properties that are specific to that reward kind

A gift card that can be used for future orders until its balance runs out

​
referee_incentive
Cart Discount Voucher · object

The referee incentive for the program, included only if one is enabled. This is a description of the incentive and does not include an actual voucher code, which is available through the referee incentive endpoint instead