Skip to main content
GET
/
v1
/
participants
/
{id}
/
state
/
tiers
/
{key}
Get participant tier
curl --request GET \
  --url https://api.scrip.dev/v1/participants/{id}/state/tiers/{key} \
  --header 'X-API-Key: <api-key>'
import requests

url = "https://api.scrip.dev/v1/participants/{id}/state/tiers/{key}"

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.scrip.dev/v1/participants/{id}/state/tiers/{key}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.scrip.dev/v1/participants/{id}/state/tiers/{key}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.scrip.dev/v1/participants/{id}/state/tiers/{key}"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("X-API-Key", "<api-key>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.scrip.dev/v1/participants/{id}/state/tiers/{key}")
.header("X-API-Key", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.scrip.dev/v1/participants/{id}/state/tiers/{key}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "acquired_at": "2024-06-01T00:00:00Z",
  "benefits": {
    "discount_pct": 10,
    "free_shipping": true
  },
  "expires_at": "2025-06-01T00:00:00Z",
  "level": "gold",
  "rank": 2
}
{
"code": "bad_request",
"details": {
"expected": "uuid",
"field": "asset_id",
"fields": [
{
"expected": "<unknown>",
"field": "amount",
"message": "This field is required",
"reason": "required",
"received": "-10.00"
}
],
"reason": "invalid",
"received": "not-a-uuid"
},
"message": "Invalid request parameters"
}
{
"code": "unauthorized",
"details": {
"expected": "uuid",
"field": "asset_id",
"fields": [
{
"expected": "<unknown>",
"field": "amount",
"message": "This field is required",
"reason": "required",
"received": "-10.00"
}
],
"reason": "invalid",
"received": "not-a-uuid"
},
"message": "Missing or invalid credentials"
}
{
"code": "not_found",
"details": {
"expected": "uuid",
"field": "asset_id",
"fields": [
{
"expected": "<unknown>",
"field": "amount",
"message": "This field is required",
"reason": "required",
"received": "-10.00"
}
],
"reason": "invalid",
"received": "not-a-uuid"
},
"message": "Resource not found"
}
{
"code": "internal_error",
"message": "An internal error occurred"
}
Returns the participant’s current level for a single tier. The key path parameter identifies which tier to look up (e.g., status), and program_id is required as a query parameter. The participant must be enrolled in the specified program. If the participant has no level assigned for the given tier, a 404 is returned.
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

id
string<uuid>
required

Participant ID

key
string
required

Tier key (e.g., status)

Query Parameters

program_id
string<uuid>
required

Program ID to scope the tier lookup

Response

Current tier state

acquired_at
string<date-time>

When this tier level was earned

Example:

"2024-06-01T00:00:00Z"

benefits
object

Benefits granted by this tier level

Example:
{ "discount_pct": 10, "free_shipping": true }
expires_at
string<date-time>

When this tier level expires

Example:

"2025-06-01T00:00:00Z"

level
string

Current tier level name

Example:

"gold"

rank
integer

Numeric rank within the tier (higher = better)

Example:

2