Tiers

Get participant tier

Returns the participant's current level for a single tier, or level "" and rank 0 when the participant holds no level in it.

get/v1/participants/{participant_id}/state/tiers/{tier_key}

Request

  • Base URL: https://api.scrip.dev
  • URL: https://api.scrip.dev/v1/participants/{participant_id}/state/tiers/{tier_key}
  • Auth: HTTP bearer

Path parameters

participant_idstring required

The participant's id, or ext: followed by the participant's external_id.

tier_keystring required

The tier's key, such as status.

Query parameters

program_idstring uuid required

Program ID to scope the tier lookup

Response

Current tier state

acquired_atstring date-time

When this tier level was earned

benefitsobject

Benefits granted by this tier level

expires_atstring date-time

When this tier level expires

levelstring

Current tier level name

rankinteger

Numeric rank within the tier (higher = better)

Example response

{
  "acquired_at": "2027-01-15T10:30:00Z",
  "benefits": {
    "discount_pct": 10,
    "free_shipping": true
  },
  "expires_at": "2027-12-31T23:59:59Z",
  "level": "gold",
  "rank": 2
}

Changes

No recorded changes to this operation across all 1 revision of this API.