v4

latestOpenAPI 3.1.02026-08-08221179273.1 KB

gamification

Get Shop Items

Get all currently available shop items.

Returns items that are currently available (within their availability window). Use /items/unlocked endpoint to determine which items the user owns.

get/api/gamification/items

Query parameters

pricing_variant'default' | 'paid_tokens'

Which shop pricing to apply. Cohort bucketing for the paid_token_exp experiment happens client-side (see paid_token_exp_treatment_allocation / paid_token_exp_legacy_cutoff_timestamp in /api/config), so the client tells the backend which price column applies for a given request.

Which price to return as token_price -- 'paid_tokens' for the paid_token_exp treatment cohort

Headers

x-user-idstring nullable

Response

Successful Response

idstring required

keystring required

namestring required

descriptionstring nullable

item_typestring required

unlock_type'free' | 'purchasable' | 'premium' | 'special' required

Item unlock types.

token_priceinteger nullable

available_fromstring date-time nullable

available_untilstring date-time nullable

sort_orderinteger

created_atstring date-time required