Skip to main content
GET
/
v1
/
programs
/
{programId}
/
tiers
List tiers
curl --request GET \
  --url https://api.scrip.dev/v1/programs/{programId}/tiers \
  --header 'X-API-Key: <api-key>'
{
  "data": [
    {
      "archived_at": "2024-03-01T00:00:00Z",
      "created_at": "2024-01-15T10:30:00Z",
      "display_name": "Loyalty Status",
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "key": "status",
      "levels": [
        {
          "benefits": {},
          "color": "#FFD700",
          "created_at": "2024-01-15T10:30:00Z",
          "display_name": "Gold",
          "icon_url": "<string>",
          "id": "550e8400-e29b-41d4-a716-446655440002",
          "key": "gold",
          "qualification": {
            "criteria": [
              {
                "counter": "nights",
                "operator": ">=",
                "threshold": 25
              }
            ],
            "mode": "ALL"
          },
          "rank": 2,
          "updated_at": "2024-01-15T10:30:00Z"
        }
      ],
      "lifecycle": {
        "counters": {
          "qualifying": [
            "<string>"
          ],
          "rollover": "EXCESS"
        },
        "downgrade_policy": {
          "mode": "DROP_ONE",
          "grace_days": 30,
          "min_level": "silver"
        },
        "qualification_period": {
          "type": "FIXED_YEAR",
          "start_day": 1,
          "start_month": 2
        },
        "retention": {
          "mode": "ACTIVITY_REFRESH",
          "duration": "2160h"
        },
        "status_validity": {
          "extend_months": 1
        }
      },
      "program_id": "550e8400-e29b-41d4-a716-446655440001",
      "status": "ACTIVE",
      "updated_at": "2024-01-15T10:30:00Z"
    }
  ],
  "pagination": {
    "has_more": true,
    "next_cursor": "YWJjMTIz"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.scrip.dev/llms.txt

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

Returns all tiers and their levels for a program. Each tier in the response includes its full configuration: levels, qualification criteria, and lifecycle settings. To retrieve the full definition of a single tier, use the get endpoint with its key instead.
For usage patterns and examples, see the Tiers guide.

Authorizations

​
X-API-Key
string
header
required

API key passed in the X-API-Key header.

Path Parameters

​
programId
string<uuid>
required

Program ID

Response

List of tiers

​
data
object[]

Data contains the list of items

​
pagination
object

Pagination contains cursor information for fetching more results