Get a tier
Returns a tier and all its levels, looked up by the tier’s key.
key. The response includes all levels with their rank, qualification criteria, and benefits, along with the tier’s lifecycle configuration.
For a listing of all tiers in a program, use the list endpoint instead.
Authorizations
API key passed in the X-API-Key header.
Response
Tier with levels
A tier definition with its levels, lifecycle configuration, and metadata
When the tier was archived (RFC 3339); absent while the tier is ACTIVE
"2024-03-01T00:00:00Z"
When this tier was created (RFC 3339)
"2024-01-15T10:30:00Z"
Human-readable name
"Loyalty Status"
Unique identifier for this tier
"550e8400-e29b-41d4-a716-446655440000"
Tier key used in API calls and rule actions
"status"
Ordered list of levels within this tier
Lifecycle configuration (retention mode, qualification period, downgrade policy, counter rollover)
Program this tier belongs to
"550e8400-e29b-41d4-a716-446655440001"
Lifecycle status: ACTIVE, or ARCHIVED once the tier has been archived
"ACTIVE"
When this tier was last modified (RFC 3339)
"2024-01-15T10:30:00Z"