Tiers

List participant tiers

Returns the participant's level in every tier the program defines, with level "" and rank 0 for a tier the participant holds no level in. State lists are not filtered by time, so this list does not accept created_after or created_before.

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

Request

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

Path parameters

participant_idstring required

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

Query parameters

program_idstring uuid required

Program ID to scope the tier lookup

Response

List of participant tier states

Example response

{
  "data": [
    {
      "acquired_at": "2027-01-15T10:30:00Z",
      "expires_at": "2027-12-31T23:59:59Z",
      "key": "status",
      "level": "gold",
      "rank": 2
    }
  ],
  "pagination": {
    "has_more": true,
    "next_cursor": "YWJjMTIz"
  }
}

Changes

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