Authorizations
Headers
The language to return the reward in. If not provided, the default language for the organisation will be used.
Path Parameters
Response
Successful response
A reward
The unique identifier of the reward
The organisation this reward belongs to
The community this reward belongs to
The additional communities this reward is available in
Used to describe an entity
The points cost to acquire one asset of this reward. Must be > 0 if allocationsType is assets-only or assets-and-entries.
x >= 0[Not yet implemented] The points value received when swapping this reward asset back. If 0, asset cannot be swapped.
x >= 0The points cost to acquire one entry for this reward. Must be > 0 if allocationsType is entries-only or assets-and-entries.
x >= 0The total supply of assets available for this reward. Must be > 0 if allocationsType is assets-only or assets-and-entries.
x >= 0The total supply of entries available for this reward. Must be > 0 if allocationsType is entries-only or assets-and-entries.
x >= 0Maximum number of assets a single user can acquire through any distribution. Must be > 0 if allocationsType is assets-only or assets-and-entries.
x >= 1Maximum number of entries a single user can acquire through any distribution. Must be > 0 if allocationsType is entries-only or assets-and-entries.
x >= 1The type of allocations for this reward. assets-only means only assets are allocable, entries-only means only entries are allocable, and assets-and-entries means both assets and entries are allocable.
assets-only, entries-only, assets-and-entries Whether the assets supply is shared across allocations. If true, the total supply of assets across all allocations will be capped at the value set here. If false, each allocation will use its own supply value.
Whether the entries supply is shared across allocations. If true, the total supply of entries across all allocations will be capped at the value set here. If false, each allocation will use its own supply value.
The allocations configured for this reward
A reward redemption config A reward redemption config rich text
- RewardRedemptionConfigRichText
- RewardRedemptionConfigCode
- Reward Redemption Config Badge
The tags the reward is linked to
The campaigns the reward is linked to
The current status of this reward
archived, draft, expired, live, scheduled Whether the giveaway should be manual (true) or automatic (false)
The organisations that the reward is available as a template for
Whether the reward is a global template
Additional metadata for the reward
When this reward was created
When this reward was last updated
Array of challenges associated with this reward
Array of achievements associated with this reward
Initial total supply of assets configured for this reward when created
x >= 0Initial total supply of entries configured for this reward when created
x >= 0Number of assets that have been distributed for this reward
x >= 0Number of entries that have been distributed for this reward
x >= 0Number of assets still available for distribution
x >= 0Number of entries still available for distribution
x >= 0Number of assets still available for purchase through the shop
x >= 0Number of entries still available for purchase through the shop
x >= 0Number of entries the current user has for this reward
x >= 0Number of assets the current user has for this reward
x >= 0Whether this reward is featured
When this reward giveaway will be drawn
When this reward becomes available
When this reward expires (or giveaway takes place)