Skip to main content
GET
Get participant tier
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:
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