GET
/
headless
/
2025-06
/
{site_id}
/
configuration
curl --request GET \
  --url https://api.loyaltylion.com/headless/2025-06/{site_id}/configuration
{
  "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 classes@example.com to sign up to a class\n",
          "html": "<p>Email classes@example.com 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,
        "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 second

If 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

Path Parameters

​
site_id
number
required

Your LoyaltyLion Site ID

Query Parameters

​
channel
enum<string>

The sales channel from which this request is made. Must be provided as this query parameter, or the X-LoyaltyLion-Channel header

Available options:
web,
pos,
mobile

Response

200
application/json

200

The response is of type object.