Get paginated leaderboard configurations

Authorizations

x-api-token

string

header

required

Headers

x-language

string

The language to return the leaderboards in. If not provided, the default language for the organisation will be used.

Query Parameters

limit

integer

default:10

Required range: 1 <= x <= 100

skip

integer

default:0

Required range: x >= 0

status

enum<string>

Available options:

archived,

draft,

expired,

live,

scheduled

string

communityId

string

Response

Successful response

totalCount

number

required

edges

object[]

required

Show child attributes

edges.name

string

required

Minimum string length: 1

edges.metricType

enum<string>

required

The type of metric to track in the leaderboard

Available options:

total-xp,

total-challenges-completed,

total-challenges-started,

total-actions-completed

edges.startsAt

string

required

edges.status

enum<string>

required

Available options:

archived,

draft,

expired,

live,

scheduled

edges.period

enum<string>

required

Available options:

daily,

weekly,

monthly,

yearly,

open

edges.conditions

object[]

required

Option 1
Option 2

Show child attributes

edges.conditions.type

enum<string>

required

Available options:

community

edges.conditions.communityId

string

required

edges.id

string

required

edges.organisationId

string

required

edges.createdAt

string

required

edges.updatedAt

string

required

edges.reward

object[]

required

Show child attributes

edges.reward.startRank

number

required

The maximum leaderboard finishing rank that wins this reward

edges.reward.endRank

number

required

The minimum leaderboard finishing rank that wins this reward

edges.reward.points

number

required

The number of points the user can earn

Required range: x >= 0

edges.reward.completionXp

number

required

Bonus XP awarded

Required range: x >= 0

edges.reward.items

Reward · object[]

required

The rewards the user can earn from the challenge

Show child attributes

edges.reward.items.id

string

required

The unique identifier of the reward

edges.reward.items.organisationId

string

required

The organisation this reward belongs to

edges.reward.items.communityId

string

required

The community this reward belongs to

edges.reward.items.additionalCommunityIds

string[]

required

The additional communities this reward is available in

edges.reward.items.details

Details · object

required

Used to describe an entity

Show child attributes

edges.reward.items.details.title

string

required

The title of the entity

edges.reward.items.details.description

string | null

required

The description of the entity

edges.reward.items.details.light

object

required

Light theme images

Show child attributes

edges.reward.items.details.light.primaryImageUrl

string | null

required

The url of the primary image for this theme mode

edges.reward.items.details.light.secondaryImageUrl

string | null

required

The url of the secondary image for this theme mode

edges.reward.items.details.dark

object

required

Dark theme images

Show child attributes

edges.reward.items.details.dark.primaryImageUrl

string | null

required

The url of the primary image for this theme mode

edges.reward.items.details.dark.secondaryImageUrl

string | null

required

The url of the secondary image for this theme mode

edges.reward.items.assetPointsPrice

number

required

The points cost to acquire one asset of this reward. Must be > 0 if allocationsType is assets-only or assets-and-entries.

Required range: x >= 0

edges.reward.items.assetPointsSwapValue

number

required

[Not yet implemented] The points value received when swapping this reward asset back. If 0, asset cannot be swapped.

Required range: x >= 0

edges.reward.items.entryPointsPrice

number

required

The points cost to acquire one entry for this reward. Must be > 0 if allocationsType is entries-only or assets-and-entries.

Required range: x >= 0

edges.reward.items.assetsSupply

required

The total supply of assets available for this reward. Must be > 0 if allocationsType is assets-only or assets-and-entries.

Required range: x >= 0

edges.reward.items.entriesSupply

required

The total supply of entries available for this reward. Must be > 0 if allocationsType is entries-only or assets-and-entries.

Required range: x >= 0

edges.reward.items.maxAssetsPerUser

required

Maximum number of assets a single user can acquire through any distribution. Must be > 0 if allocationsType is assets-only or assets-and-entries.

Required range: x >= 1

edges.reward.items.maxEntriesPerUser

required

Maximum number of entries a single user can acquire through any distribution. Must be > 0 if allocationsType is entries-only or assets-and-entries.

Required range: x >= 1

edges.reward.items.allocationsType

enum<string>

required

The 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.

Available options:

assets-only,

entries-only,

assets-and-entries

edges.reward.items.isSharedAssetsSupply

boolean

required

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.

edges.reward.items.isSharedEntriesSupply

boolean

required

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.

edges.reward.items.allocations

RewardAllocation · object[]

required

The allocations configured for this reward

Show child attributes

edges.reward.items.allocations.id

string

required

The ID of this allocation

edges.reward.items.allocations.allocationType

enum<string>

required

The type of allocation, either assets or entries. If the reward has a type of assets-and-entries, this allocation can have both assets and entries. Otherwise, it can only have one type matching the reward's allocation type.

Available options:

assets,

entries

edges.reward.items.allocations.supply

required

The total supply of this allocation. Only used if isSharedAssetsSupply or isSharedEntriesSupply is false on the reward.

Required range: x >= 0

edges.reward.items.allocations.amountToDistribute

number

required

The quantity of this specific reward to distribute when this allocation is selected. For example, if amountToDistribute is 3, then 3 units of this reward will be given to the recipient.

Required range: x >= 1

edges.reward.items.allocations.distributed

number

required

The amount already distributed for this allocation

Required range: x >= 0

edges.reward.items.allocations.isShop

boolean

required

Whether this allocation is for the shop

edges.reward.items.allocations.isLive

boolean

required

Whether this allocation is live

edges.reward.items.redemptionConfig

RewardRedemptionConfigRichText · object

required

A reward redemption config

RewardRedemptionConfigRichText
RewardRedemptionConfigCode
Reward Redemption Config Badge

Show child attributes

edges.reward.items.redemptionConfig.type

enum<string>

required

Rich text redemption config

Available options:

rich-text

edges.reward.items.redemptionConfig.additionalInformation

Variable Config Reference · object[]

required

Configurable form fields to collect additional user information when user redeems the reward. Each field (e.g., email, phone, address) is defined by a variable config that specifies its type, validation rules, and display order.

Show child attributes

edges.reward.items.redemptionConfig.additionalInformation.variableConfigId

string

required

The ID of the variable config that defines the data type, validation rules, and UI rendering

edges.reward.items.redemptionConfig.additionalInformation.required

boolean

required

Whether this variable must be filled out by the user before proceeding

edges.reward.items.redemptionConfig.additionalInformation.position

number

required

The display order position of this variable in the form or UI

Required range: x >= 1

edges.reward.items.redemptionConfig.autoRedeem

boolean

required

Whether the reward should be automatically redeemed when claimed

Example:

false

edges.reward.items.redemptionConfig.content

string

required

The rich text content. HTML is supported.

edges.reward.items.redemptionConfig.instructions

string | null

Instructions for redeeming this reward. HTML is supported.

edges.reward.items.redemptionConfig.instructionsImageUrl

string | null

The URL of an image to display with the instructions

edges.reward.items.redemptionConfig.supportEmail

string<email> | null

The email address of the support team

edges.reward.items.redemptionConfig.supportPhoneNumber

string | null

The phone number of the support team

edges.reward.items.redemptionConfig.supportUrl

string | null

The URL of the support team

edges.reward.items.redemptionConfig.redeemByDate

string | null

The date by which the reward can be redeemed

edges.reward.items.tags

Tag · object[]

required

The tags the reward is linked to

Show child attributes

edges.reward.items.tags.id

string

required

The id of the tag

edges.reward.items.tags.organisationId

string

required

The id of the organisation the tag belongs to

edges.reward.items.tags.value

string

required

The value of the tag

Minimum string length: 1

edges.reward.items.tags.config

TagConfig · object

required

The configuration of a tag

Show child attributes

edges.reward.items.tags.config.filtering

enum<string>[]

required

The filtering options for the tag

Available options:

achievement,

action,

community,

challenge,

post,

reward,

reward-asset,

reward-entry

edges.reward.items.tags.config.display

enum<string>[]

required

The display options for the tag

Available options:

achievement,

action,

community,

challenge,

post,

reward,

reward-asset,

reward-entry

edges.reward.items.tags.config.iconifyIcon

string | null

The iconify icon for the tag

edges.reward.items.tags.createdAt

string

required

The date the tag was created

edges.reward.items.tags.updatedAt

string

required

The date the tag was last updated

edges.reward.items.campaigns

Campaign · object[]

required

The campaigns the reward is linked to

Show child attributes

edges.reward.items.campaigns.id

string

required

The id of the campaign

edges.reward.items.campaigns.organisationId

string

required

The id of the organisation the campaign belongs to

edges.reward.items.campaigns.name

string

required

The name of the campaign

edges.reward.items.campaigns.startDate

string

required

The start date of the campaign

edges.reward.items.campaigns.endDate

string

required

The end date of the campaign

edges.reward.items.campaigns.status

enum<string>

required

The status of the campaign

Available options:

archived,

draft,

expired,

live,

scheduled

edges.reward.items.campaigns.createdAt

string

required

The date the campaign was created

edges.reward.items.campaigns.updatedAt

string

required

The date the campaign was last updated

edges.reward.items.status

enum<string>

required

The current status of this reward

Available options:

archived,

draft,

expired,

live,

scheduled

edges.reward.items.isManualGiveaway

boolean

required

Whether the giveaway should be manual (true) or automatic (false)

edges.reward.items.availableAsTemplateForOrganisations

string[]

required

The organisations that the reward is available as a template for

edges.reward.items.isGlobalTemplate

boolean

required

Whether the reward is a global template

edges.reward.items.metadata

object

required

Additional metadata for the reward

Show child attributes

edges.reward.items.metadata.{key}

edges.reward.items.createdAt

string

required

When this reward was created

edges.reward.items.updatedAt

string

required

When this reward was last updated

edges.reward.items.challenges

Challenge · object[]

required

Array of challenges associated with this reward

Show child attributes

edges.reward.items.challenges.id

string

required

The id of the challenge

edges.reward.items.challenges.organisationId

string

required

The id of the organisation the challenge belongs to

edges.reward.items.challenges.communityId

string

required

The id of the community the challenge belongs to

edges.reward.items.challenges.additionalCommunityIds

string[]

required

The ids of any additional communities the challenge belongs to

edges.reward.items.challenges.details

Details · object

required

Used to describe an entity

Show child attributes

edges.reward.items.challenges.details.title

string

required

The title of the entity

edges.reward.items.challenges.details.description

string | null

required

The description of the entity

edges.reward.items.challenges.details.light

object

required

Light theme images

Show child attributes

edges.reward.items.challenges.details.light.primaryImageUrl

string | null

required

The url of the primary image for this theme mode

edges.reward.items.challenges.details.light.secondaryImageUrl

string | null

required

The url of the secondary image for this theme mode

edges.reward.items.challenges.details.dark

object

required

Dark theme images

Show child attributes

edges.reward.items.challenges.details.dark.primaryImageUrl

string | null

required

The url of the primary image for this theme mode

edges.reward.items.challenges.details.dark.secondaryImageUrl

string | null

required

The url of the secondary image for this theme mode

edges.reward.items.challenges.progressPeriod

enum<string>

required

The progress period of the challenge

Available options:

daily,

weekly,

monthly,

yearly,

open

edges.reward.items.challenges.maxCompletionsPerPeriod

required

The maximum number of completions per period for the challenge

Required range: x >= 0

edges.reward.items.challenges.numberOfActions

number

required

The number of actions in the challenge

Required range: x >= 0

edges.reward.items.challenges.actionIds

string[]

required

The ids of the actions in the challenge

edges.reward.items.challenges.actionGroups

ActionGroup · object[]

required

The action groups of the challenge

Show child attributes

edges.reward.items.challenges.actionGroups.id

string

required

edges.reward.items.challenges.actionGroups.type

enum<string>

required

Available options:

single,

group,

child

edges.reward.items.challenges.actionGroups.details

Details · object

required

Used to describe an entity

Show child attributes

edges.reward.items.challenges.actionGroups.details.title

string

required

The title of the entity

edges.reward.items.challenges.actionGroups.details.description

string | null

required

The description of the entity

edges.reward.items.challenges.actionGroups.details.light

object

required

Light theme images

Show child attributes

edges.reward.items.challenges.actionGroups.details.light.primaryImageUrl

string | null

required

The url of the primary image for this theme mode

edges.reward.items.challenges.actionGroups.details.light.secondaryImageUrl

string | null

required

The url of the secondary image for this theme mode

edges.reward.items.challenges.actionGroups.details.dark

object

required

Dark theme images

Show child attributes

edges.reward.items.challenges.actionGroups.details.dark.primaryImageUrl

string | null

required

The url of the primary image for this theme mode

edges.reward.items.challenges.actionGroups.details.dark.secondaryImageUrl

string | null

required

The url of the secondary image for this theme mode

edges.reward.items.challenges.actionGroups.parentGroupId

string | null

edges.reward.items.challenges.actionGroups.displayType

enum<string> | null

Available options:

list,

grid,

stepper,

map,

chapters,

widget,

edges.reward.items.challenges.status

enum<string>

required

The status of the challenge

Available options:

archived,

draft,

expired,

live,

scheduled

edges.reward.items.challenges.isLinear

boolean

required

Whether the challenge must be completed in sequential order

edges.reward.items.challenges.unlockPrice

number

required

The number of keys required to unlock this challenge

Required range: x >= 0

edges.reward.items.challenges.tags

Tag · object[]

required

The tags the challenge is linked to

Show child attributes

edges.reward.items.challenges.tags.id

string

required

The id of the tag

edges.reward.items.challenges.tags.organisationId

string

required

The id of the organisation the tag belongs to

edges.reward.items.challenges.tags.value

string

required

The value of the tag

Minimum string length: 1

edges.reward.items.challenges.tags.config

TagConfig · object

required

The configuration of a tag

Show child attributes

edges.reward.items.challenges.tags.config.filtering

enum<string>[]

required

The filtering options for the tag

Available options:

achievement,

action,

community,

challenge,

post,

reward,

reward-asset,

reward-entry

edges.reward.items.challenges.tags.config.display

enum<string>[]

required

The display options for the tag

Available options:

achievement,

action,

community,

challenge,

post,

reward,

reward-asset,

reward-entry

edges.reward.items.challenges.tags.config.iconifyIcon

string | null

The iconify icon for the tag

edges.reward.items.challenges.tags.createdAt

string

required

The date the tag was created

edges.reward.items.challenges.tags.updatedAt

string

required

The date the tag was last updated

edges.reward.items.challenges.campaigns

Campaign · object[]

required

The campaigns the challenge is linked to

Show child attributes

edges.reward.items.challenges.campaigns.id

string

required

The id of the campaign

edges.reward.items.challenges.campaigns.organisationId

string

required

The id of the organisation the campaign belongs to

edges.reward.items.challenges.campaigns.name

string

required

The name of the campaign

edges.reward.items.challenges.campaigns.startDate

string

required

The start date of the campaign

edges.reward.items.challenges.campaigns.endDate

string

required

The end date of the campaign

edges.reward.items.challenges.campaigns.status

enum<string>

required

The status of the campaign

Available options:

archived,

draft,

expired,

live,

scheduled

edges.reward.items.challenges.campaigns.createdAt

string

required

The date the campaign was created

edges.reward.items.challenges.campaigns.updatedAt

string

required

The date the campaign was last updated

edges.reward.items.challenges.availableAsTemplateForOrganisations

string[]

required

The organisations that the challenge is available as a template for

edges.reward.items.challenges.isGlobalTemplate

boolean

required

Whether the challenge is a global template

edges.reward.items.challenges.groupIds

string[]

required

The challenge groups the challenge belongs to

edges.reward.items.challenges.createdAt

string

required

The creation date of the challenge

edges.reward.items.challenges.videoConfig

Video Config · object

required

Video configuration for challenges with video content

Show child attributes

edges.reward.items.challenges.videoConfig.videoUrl

string

required

The URL of the video

edges.reward.items.challenges.videoConfig.isVideoEnabled

boolean

required

Whether video functionality is enabled for this challenge

edges.reward.items.challenges.actions

Action · object[]

required

The actions of the challenge

Show child attributes

edges.reward.items.challenges.actions.id

string

required

The id of the action

edges.reward.items.challenges.actions.organisationId

string

required

The organisation that the action belongs to

edges.reward.items.challenges.actions.communityId

string

required

The community that the action belongs to

edges.reward.items.challenges.actions.allocationId

string

required

The allocation this action is assigned to. This can be set to a challenge only at the moment.

edges.reward.items.challenges.actions.allocatedTo

enum<string>

required

The entity type this action is allocated to. This can be set to a 'challenge' only at the moment.

Available options:

achievement,

action,

community,

challenge,

post,

reward,

reward-asset,

reward-entry

edges.reward.items.challenges.actions.position

number

required

The display position of this action

edges.reward.items.challenges.actions.category

enum<string>

required

The category of this action

Available options:

nudj,

discord,

facebook,

imageAnalysis,

instagram,

interaction,

linkedin,

question,

platform,

spotify,

tiktok,

twitter,

youtube

edges.reward.items.challenges.actions.key

enum<string>

required

The specific type of this action

Available options:

facebook-comment,

facebook-follow,

facebook-like,

image-analysis-object-detection,

image-analysis-receipt-detection,

instagram-follow,

instagram-like,

instagram-comment,

instagram-share,

instagram-post,

interaction-engage-with-content,

interaction-external-link,

interaction-image-upload,

interaction-spot-object,

platform-comment-on-post,

platform-complete-achievement,

platform-generative-action,

platform-like-post,

platform-play-game,

platform-validate-event,

question-multiple-choice,

question-open-ended,

question-rate-your-experience,

question-secret-access-code,

question-select-date,

question-select-from-images,

question-select-value-in-range,

question-select-from-list,

question-closed-ended,

question-vote,

spotify-follow,

spotify-listen,

spotify-save,

tiktok-follow,

tiktok-watch,

tiktok-post,

youtube-like,

youtube-comment,

youtube-subscribe

edges.reward.items.challenges.actions.details

Details · object

required

The details of this action such as title, description, bannerUrl, logoUrl

Show child attributes

edges.reward.items.challenges.actions.details.title

string

required

The title of the entity

edges.reward.items.challenges.actions.details.description

string | null

required

The description of the entity

edges.reward.items.challenges.actions.details.light

object

required

Light theme images

Show child attributes

edges.reward.items.challenges.actions.details.light.primaryImageUrl

string | null

required

The url of the primary image for this theme mode

edges.reward.items.challenges.actions.details.light.secondaryImageUrl

string | null

required

The url of the secondary image for this theme mode

edges.reward.items.challenges.actions.details.dark

object

required

Dark theme images

Show child attributes

edges.reward.items.challenges.actions.details.dark.primaryImageUrl

string | null

required

The url of the primary image for this theme mode

edges.reward.items.challenges.actions.details.dark.secondaryImageUrl

string | null

required

The url of the secondary image for this theme mode

edges.reward.items.challenges.actions.progressPeriod

enum<string>

required

The progress period of the action

Available options:

daily,

weekly,

monthly,

yearly,

open

edges.reward.items.challenges.actions.maxCompletionsPerPeriod

required

The maximum number of completions per period for the action

Required range: x >= 0

edges.reward.items.challenges.actions.attributes

Multiple Choice Question · object

required

The specific attributes for this action type. This must symantically match the key of this action.

Multiple Choice Question
Open Ended Question
Rate Your Experience Question
Secret Access Code Question
Select From Images Question
Select From List Question
Single Fixed Answer Question
Vote Question
Select A Date Question
Select Value In Range Question
External Link Interaction
Engage With Content Interaction
Image Upload Interaction
Spot Object Action
Object Detection Action Attributes
Receipt Detection Action Attributes
Facebook Comment Action Attributes
Facebook Follow Action Attributes
Facebook Like Action Attributes
Instagram Follow Action Attributes
Instagram Like Action Attributes
Instagram Comment Action Attributes
Instagram Share Action Attributes
Instagram Post Action Attributes
Comment On Post Action Attributes
Complete Achievement Action Attributes
Generative Action Attributes
Like Post Action Attributes
Play Game Action Attributes
Validate Event Action Attributes
Spotify Follow Action Attributes
Spotify Listen Action Attributes
Spotify Save Action Attributes
Youtube Comment Action Attributes
Youtube Subscribe Action Attributes
Youtube Like Action Attributes
TikTok Follow Action Attributes
TikTok Post Video With Hashtag Action Attributes
TikTok Watch Video Action Attributes

Show child attributes

edges.reward.items.challenges.actions.attributes.key

enum<string>

required

The multiple choice question action key

Available options:

question-multiple-choice

edges.reward.items.challenges.actions.attributes.question

string

required

The multiple choice question to be answered ie 'What is your favorite color?'

Minimum string length: 1

edges.reward.items.challenges.actions.attributes.options

object[]

required

The multiple choice options available to answer the question

Minimum array length: 2

Show child attributes

edges.reward.items.challenges.actions.attributes.options.id

string

required

The id of the option. This is used to identify the option and each option must be unique ie '1' or '2'

edges.reward.items.challenges.actions.attributes.options.label

string

required

The label of the option ie 'Red' or 'Blue'

edges.reward.items.challenges.actions.attributes.minimumNumberOfAnswersRequired

number

required

The minimum number of answers required

Required range: x >= 1

edges.reward.items.challenges.actions.attributes.maximumNumberOfAnswersAllowed

number

required

The maximum number of answers allowed

Required range: x >= 1

edges.reward.items.challenges.actions.config

ActionConfig · object

required

The configuration settings for this action

Show child attributes

edges.reward.items.challenges.actions.config.isOptional

boolean

required

Whether this action is optional

Controls how social media validation is handled:

validation-on: Strict validation is enforced. The action will only be marked as complete if the social media activity is verified.
validation-off: No validation is performed. The action is automatically marked as complete.
user-choice: Allows users to choose whether to bypass validation by setting isBypass=true in their action input. If isBypass=false, full validation will be performed.

Available options:

validation-on,

validation-off,

user-choice

edges.reward.items.challenges.actions.config.prerequisites

ActionPrerequisite · object

Used to configure a prerequisite for an action

Show child attributes

edges.reward.items.challenges.actions.config.prerequisites.requiredActionCount

number

required

Number of actions that must be completed within the same allocation to unlock this action

edges.reward.items.challenges.actions.config.prerequisites.actionIds

string[]

required

Array of specific action IDs that must be completed in the same allocation

edges.reward.items.challenges.actions.config.requiresCorrectAnswer

boolean

Whether the action must be answered correctly to count toward challenge completion. When false, any participation counts toward completion but only correct answers earn rewards.

edges.reward.items.challenges.actions.videoMetadata

Video Metadata · object

required

Video metadata for actions with video content

Show child attributes

edges.reward.items.challenges.actions.videoMetadata.startsAtMs

number

required

The start time of the action in milliseconds from the start of the video

Required range: x >= 0

edges.reward.items.challenges.actions.videoMetadata.shouldPause

boolean

required

Whether the video should pause at the validation point

edges.reward.items.challenges.actions.videoMetadata.validatesAtMs

number | null

required

The validation time in milliseconds, null if the user will validate themselves

Required range: x >= 0

edges.reward.items.challenges.actions.videoMetadata.endsAtMs

number

required

The end time of the action in milliseconds from the start of the video

Required range: x >= 0

edges.reward.items.challenges.actions.createdAt

string

required

The date when this action was created

edges.reward.items.challenges.actions.stats

object

required

Show child attributes

edges.reward.items.challenges.actions.stats.totalXp

number | null

The total XP that can be earned from this action

edges.reward.items.challenges.actions.reward

Entity Reward Distribution · object

required

A reward distribution for an entity

Show child attributes

edges.reward.items.challenges.actions.reward.points

number

required

Number of points awarded

Required range: x >= 0

edges.reward.items.challenges.actions.reward.completionXp

number

required

Amount of XP awarded for completion

Required range: x >= 0

edges.reward.items.challenges.actions.reward.items

Reward Distribution Item · object[]

required

Reward items available

Show child attributes

edges.reward.items.challenges.actions.reward.items.id

string

required

The unique identifier of the reward

edges.reward.items.challenges.actions.reward.items.details

Details · object

required

Used to describe an entity

Show child attributes

edges.reward.items.challenges.actions.reward.items.details.title

string

required

The title of the entity

edges.reward.items.challenges.actions.reward.items.details.description

string | null

required

The description of the entity

edges.reward.items.challenges.actions.reward.items.details.light

object

required

Light theme images

Show child attributes

edges.reward.items.challenges.actions.reward.items.details.light.primaryImageUrl

string | null

required

The url of the primary image for this theme mode

edges.reward.items.challenges.actions.reward.items.details.light.secondaryImageUrl

string | null

required

The url of the secondary image for this theme mode

edges.reward.items.challenges.actions.reward.items.details.dark

object

required

Dark theme images

Show child attributes

edges.reward.items.challenges.actions.reward.items.details.dark.primaryImageUrl

string | null

required

The url of the primary image for this theme mode

edges.reward.items.challenges.actions.reward.items.details.dark.secondaryImageUrl

string | null

required

The url of the secondary image for this theme mode

edges.reward.items.challenges.actions.reward.items.type

enum<string>

required

The type of reward allocation (assets or entries)

Available options:

assets,

entries

edges.reward.items.challenges.actions.reward.items.amountToDistribute

number

required

Amount of this reward to distribute

Required range: x >= 0

edges.reward.items.challenges.actions.reward.items.totalSupply

required

Total supply available for this reward

Required range: x >= 0

edges.reward.items.challenges.actions.reward.items.remainingSupply

required

Number of items still available for distribution

Required range: x >= 0

edges.reward.items.challenges.actions.reward.rewardSelectionMethod

enum<string> | null

required

Method for reward selection

Available options:

all,

priority,

random,

select,

edges.reward.items.challenges.actions.reward.numberOfRewardsToReceive

number

required

Number of rewards to receive

Required range: x >= 0

edges.reward.items.challenges.actions.reward.distributionEventId

string | null

required

ID of the distribution event

edges.reward.items.challenges.actions.userState

object

required

Show child attributes

edges.reward.items.challenges.actions.userState.status

enum<string>

required

Current progress state of the action for the user

Available options:

completed,

in-progress,

locked,

not-started,

repeatable,

skipped

edges.reward.items.challenges.actions.userState.criteriaMet

boolean | null

Indicates whether the user has successfully completed the action's requirements

edges.reward.items.challenges.actions.userState.statusMessage

string | null

Human-readable message explaining the current status to the user

edges.reward.items.challenges.actions.userState.eligibleXp

number | null

The XP available for the user to earn. This decreases with failed attempts and becomes 0 once completed

edges.reward.items.challenges.actions.userState.earnedXp

number | null

Total XP the user has earned from this action so far

edges.reward.items.challenges.actions.userState.attempts

number | null

Number of times the user has attempted this action

edges.reward.items.challenges.actions.userState.output

ExternalLinkActionOutput · object

Results from the user's most recent attempt

ExternalLinkActionOutput
EngageWithContentActionOutput
ImageUploadActionOutput
SpotObjectActionOutput
OpenEndedActionOutput
MultipleChoiceActionOutput
SingleFixedAnswerActionOutput
SelectFromImagesActionOutput
RateYourExperienceActionOutput
SelectFromListActionOutput
SecretAccessCodeActionOutput
VoteActionOutput
SelectADateActionOutput
SelectValueInRangeActionOutput
ObjectDetectionActionOutput
ReceiptDetectionActionOutput
FacebookCommentActionOutput
FacebookFollowActionOutput
FacebookLikeActionOutput
InstagramFollowActionOutput
InstagramLikeActionOutput
InstagramCommentActionOutput
InstagramShareActionOutput
InstagramPostActionOutput
CommentOnPostActionOutput
CompleteAchievementActionOutput
GenerativeActionActionOutput
LikePostActionOutput
PlayGameActionOutput
Validate Event Action Output
SpotifyFollowActionOutput
SpotifyListenActionOutput
SpotifySaveActionOutput
TikTokFollowActionOutput
TikTokPostActionOutput
TikTokWatchActionOutput
YoutubeCommentActionOutput
YoutubeSubscribeActionOutput
YoutubeLikeActionOutput

Show child attributes

edges.reward.items.challenges.actions.userState.output.key

enum<string>

required

Available options:

interaction-external-link

edges.reward.items.challenges.actions.userState.output.eventId

string | null

edges.reward.items.challenges.actions.userState.unmetCriteriaMessage

string | null

Explanation of why the action requirements haven't been met, if applicable

edges.reward.items.challenges.actions.participations

ActionParticipationStatus · object[]

required

History of all user attempts and interactions with this action

Show child attributes

edges.reward.items.challenges.actions.participations.id

string

required

edges.reward.items.challenges.actions.participations.criteriaMet

boolean

required

edges.reward.items.challenges.actions.participations.output

ExternalLinkActionOutput · object

required

The output of an action.

ExternalLinkActionOutput
EngageWithContentActionOutput
ImageUploadActionOutput
SpotObjectActionOutput
OpenEndedActionOutput
MultipleChoiceActionOutput
SingleFixedAnswerActionOutput
SelectFromImagesActionOutput
RateYourExperienceActionOutput
SelectFromListActionOutput
SecretAccessCodeActionOutput
VoteActionOutput
SelectADateActionOutput
SelectValueInRangeActionOutput
ObjectDetectionActionOutput
ReceiptDetectionActionOutput
FacebookCommentActionOutput
FacebookFollowActionOutput
FacebookLikeActionOutput
InstagramFollowActionOutput
InstagramLikeActionOutput
InstagramCommentActionOutput
InstagramShareActionOutput
InstagramPostActionOutput
CommentOnPostActionOutput
CompleteAchievementActionOutput
GenerativeActionActionOutput
LikePostActionOutput
PlayGameActionOutput
Validate Event Action Output
SpotifyFollowActionOutput
SpotifyListenActionOutput
SpotifySaveActionOutput
TikTokFollowActionOutput
TikTokPostActionOutput
TikTokWatchActionOutput
YoutubeCommentActionOutput
YoutubeSubscribeActionOutput
YoutubeLikeActionOutput

Show child attributes

edges.reward.items.challenges.actions.participations.output.key

enum<string>

required

Available options:

interaction-external-link

edges.reward.items.challenges.actions.participations.output.eventId

string | null

edges.reward.items.challenges.actions.participations.status

enum<string>

required

Available options:

pending,

in-progress,

processed,

failed

edges.reward.items.challenges.actions.participations.participatedAt

string

required

edges.reward.items.challenges.actions.participations.processingStartedAt

string | null

edges.reward.items.challenges.actions.participations.processedAt

string | null

edges.reward.items.challenges.actions.participations.unmetCriteriaMessage

string | null

edges.reward.items.challenges.actions.participations.processingFailedMessage

string | null

edges.reward.items.challenges.actions.actionGroupId

string | null

The action group this action belongs to

edges.reward.items.challenges.actions.actionGroupIndex

number | null

The index of this action within its action group

edges.reward.items.challenges.actions.availableAsTemplateForOrganisations

string[] | null

List of organisation IDs that can use this action as a template

edges.reward.items.challenges.actions.isGlobalTemplate

boolean | null

Indicates if this action is available as a template globally across all organisations

edges.reward.items.challenges.actions.previousAction

string | null

ID of the action that precedes this one in sequence

edges.reward.items.challenges.actions.nextAction

string | null

ID of the action that follows this one in sequence

edges.reward.items.challenges.community

object

required

Details of the community this challenge belongs to

Show child attributes

edges.reward.items.challenges.community.id

string

required

The id of the community

edges.reward.items.challenges.community.name

string

required

The name of the community

edges.reward.items.challenges.community.description

string

required

The description of the community

edges.reward.items.challenges.community.slug

string

required

The slug of the community

edges.reward.items.challenges.community.logo

string<uri> | null

The url of the community logo image

edges.reward.items.challenges.participantStats

object

required

Show child attributes

edges.reward.items.challenges.participantStats.startedCount

number

required

The number of participants who have started the challenge

Required range: x >= 0

edges.reward.items.challenges.participantStats.completedCount

number

required

The number of participants who have completed the challenge

Required range: x >= 0

edges.reward.items.challenges.stats

object

required

Show child attributes

edges.reward.items.challenges.stats.totalXp

number

required

The total XP that can be earned from completing all actions in this challenge (excluding completion bonus)

Required range: x >= 0

edges.reward.items.challenges.stats.totalActionsCount

number

required

The total number of actions in this challenge

Required range: x >= 0

edges.reward.items.challenges.reward

Entity Reward Distribution · object

required

A reward distribution for an entity

Show child attributes

edges.reward.items.challenges.reward.points

number

required

Number of points awarded

Required range: x >= 0

edges.reward.items.challenges.reward.completionXp

number

required

Amount of XP awarded for completion

Required range: x >= 0

edges.reward.items.challenges.reward.items

Reward Distribution Item · object[]

required

Reward items available

Show child attributes

edges.reward.items.challenges.reward.items.id

string

required

The unique identifier of the reward

edges.reward.items.challenges.reward.items.details

Details · object

required

Used to describe an entity

Show child attributes

edges.reward.items.challenges.reward.items.details.title

string

required

The title of the entity

edges.reward.items.challenges.reward.items.details.description

string | null

required

The description of the entity

edges.reward.items.challenges.reward.items.details.light

object

required

Light theme images

Show child attributes

edges.reward.items.challenges.reward.items.details.light.primaryImageUrl

string | null

required

The url of the primary image for this theme mode

edges.reward.items.challenges.reward.items.details.light.secondaryImageUrl

string | null

required

The url of the secondary image for this theme mode

edges.reward.items.challenges.reward.items.details.dark

object

required

Dark theme images

Show child attributes

edges.reward.items.challenges.reward.items.details.dark.primaryImageUrl

string | null

required

The url of the primary image for this theme mode

edges.reward.items.challenges.reward.items.details.dark.secondaryImageUrl

string | null

required

The url of the secondary image for this theme mode

edges.reward.items.challenges.reward.items.type

enum<string>

required

The type of reward allocation (assets or entries)

Available options:

assets,

entries

edges.reward.items.challenges.reward.items.amountToDistribute

number

required

Amount of this reward to distribute

Required range: x >= 0

edges.reward.items.challenges.reward.items.totalSupply

required

Total supply available for this reward

Required range: x >= 0

edges.reward.items.challenges.reward.items.remainingSupply

required

Number of items still available for distribution

Required range: x >= 0

edges.reward.items.challenges.reward.rewardSelectionMethod

enum<string> | null

required

Method for reward selection

Available options:

all,

priority,

random,

select,

edges.reward.items.challenges.reward.numberOfRewardsToReceive

number

required

Number of rewards to receive

Required range: x >= 0

edges.reward.items.challenges.reward.distributionEventId

string | null

required

ID of the distribution event

edges.reward.items.challenges.userState

object

required

Show child attributes

edges.reward.items.challenges.userState.status

enum<string>

required

Current progress state of the user's active attempt at the challenge. (not-started, in-progress, completed, repeatable, locked)

Available options:

completed,

in-progress,

locked,

not-started,

repeatable,

skipped

edges.reward.items.challenges.userState.completionsInPeriod

number

default:0

required

The number of times the user has completed this challenge in the current period

Required range: x >= 0

edges.reward.items.challenges.userState.totalCompletions

number

default:0

required

The total number of times the user has completed this challenge across all periods

Required range: x >= 0

edges.reward.items.challenges.userState.keysContributed

number

default:0

required

The number of keys the user has contributed towards unlocking this challenge

Required range: x >= 0

edges.reward.items.challenges.userState.latestAttempt

object

required

Show child attributes

edges.reward.items.challenges.userState.latestAttempt.eligibleXp

number

default:0

required

The XP available for the user to earn. This decreases with failed attempts and becomes 0 once completed

Required range: x >= 0

edges.reward.items.challenges.userState.latestAttempt.actionsCompletedCount

number

default:0

required

The number of actions the user has completed in the current run of this challenge

Required range: x >= 0

edges.reward.items.challenges.userState.latestAttempt.earnedXp

number

default:0

required

Total XP the user has earned so far from this challenge (includes both action XP and completion bonus if completed)

Required range: x >= 0

edges.reward.items.challenges.userState.latestAttempt.earnedPoints

number

default:0

required

Total points the user has earned from this challenge

Required range: x >= 0

edges.reward.items.challenges.userState.latestAttempt.earnedRewardAssets

object[]

required

The reward assets the user has earned from this challenge

Show child attributes

edges.reward.items.challenges.userState.latestAttempt.earnedRewardAssets.rewardAssetId

string

required

The ID of the reward asset earned

edges.reward.items.challenges.userState.latestAttempt.earnedRewardAssets.rewardId

string

required

The ID of the reward this asset belongs to

edges.reward.items.challenges.userState.latestAttempt.earnedRewardEntries

object[]

required

The reward entries the user has earned from this challenge

Show child attributes

edges.reward.items.challenges.userState.latestAttempt.earnedRewardEntries.rewardEntryId

string

required

The ID of the reward entry earned

edges.reward.items.challenges.userState.latestAttempt.earnedRewardEntries.rewardId

string

required

The ID of the reward this entry belongs to

edges.reward.items.challenges.userState.latestAttempt.earnedRewardEntries.amount

number

required

Amount refers to entries won from this challenge only

Required range: x >= 0

edges.reward.items.challenges.userState.latestAttempt.completionTime

number

default:0

required

Time taken to complete the challenge in seconds with 2 decimal places precision (e.g. 1.34). 0 if not started.

Required range: x >= 0

edges.reward.items.challenges.userState.latestAttempt.successRate

number

default:0

required

Percentage of correct answers/successful attempts across all actions (0-100)

Required range: 0 <= x <= 100

edges.reward.items.challenges.userState.latestAttempt.startedAt

string | null

The timestamp when the user started their current attempt at this challenge

edges.reward.items.challenges.userState.historicAttempts

object[]

required

Historic attempts of the user for this challenge in the current period

Show child attributes

edges.reward.items.challenges.userState.historicAttempts.eligibleXp

number

default:0

required

The XP available for the user to earn. This decreases with failed attempts and becomes 0 once completed

Required range: x >= 0

edges.reward.items.challenges.userState.historicAttempts.actionsCompletedCount

number

default:0

required

The number of actions the user has completed in the current run of this challenge

Required range: x >= 0

edges.reward.items.challenges.userState.historicAttempts.earnedXp

number

default:0

required

Total XP the user has earned so far from this challenge (includes both action XP and completion bonus if completed)

Required range: x >= 0

edges.reward.items.challenges.userState.historicAttempts.earnedPoints

number

default:0

required

Total points the user has earned from this challenge

Required range: x >= 0

edges.reward.items.challenges.userState.historicAttempts.earnedRewardAssets

object[]

required

The reward assets the user has earned from this challenge

Show child attributes

edges.reward.items.challenges.userState.historicAttempts.earnedRewardAssets.rewardAssetId

string

required

The ID of the reward asset earned

edges.reward.items.challenges.userState.historicAttempts.earnedRewardAssets.rewardId

string

required

The ID of the reward this asset belongs to

edges.reward.items.challenges.userState.historicAttempts.earnedRewardEntries

object[]

required

The reward entries the user has earned from this challenge

Show child attributes

edges.reward.items.challenges.userState.historicAttempts.earnedRewardEntries.rewardEntryId

string

required

The ID of the reward entry earned

edges.reward.items.challenges.userState.historicAttempts.earnedRewardEntries.rewardId

string

required

The ID of the reward this entry belongs to

edges.reward.items.challenges.userState.historicAttempts.earnedRewardEntries.amount

number

required

Amount refers to entries won from this challenge only

Required range: x >= 0

edges.reward.items.challenges.userState.historicAttempts.completionTime

number

default:0

required

Time taken to complete the challenge in seconds with 2 decimal places precision (e.g. 1.34). 0 if not started.

Required range: x >= 0

edges.reward.items.challenges.userState.historicAttempts.successRate

number

default:0

required

Percentage of correct answers/successful attempts across all actions (0-100)

Required range: 0 <= x <= 100

edges.reward.items.challenges.userState.historicAttempts.startedAt

string | null

The timestamp when the user started their current attempt at this challenge

edges.reward.items.challenges.challengeType

enum<string> | null

The type of the challenge

Available options:

survey,

edges.reward.items.challenges.enabledForSingleView

boolean | null

Whether the challenge is enabled for single view

edges.reward.items.challenges.startDate

string | null

Deprecated use startsAt instead

edges.reward.items.challenges.endDate

string | null

Deprecated use expiresAt instead

edges.reward.items.challenges.featured

boolean | null

edges.reward.items.challenges.threadId

string | null

The thread id of the challenge

edges.reward.items.challenges.isSkippable

boolean | null

Whether the challenge is skippable

edges.reward.items.challenges.startsAt

string | null

The start date of the challenge

edges.reward.items.challenges.expiresAt

string | null

The expiry date of the challenge

edges.reward.items.challenges.updatedAt

string | null

The update date of the challenge

edges.reward.items.achievements

Achievement · object[]

required

Array of achievements associated with this reward

Show child attributes

edges.reward.items.achievements.id

string

required

The id of the achievement

edges.reward.items.achievements.organisationId

string

required

The id of the organisation this achievement belongs to

edges.reward.items.achievements.details

Details · object

required

Used to describe an entity

Show child attributes

edges.reward.items.achievements.details.title

string

required

The title of the entity

edges.reward.items.achievements.details.description

string | null

required

The description of the entity

edges.reward.items.achievements.details.light

object

required

Light theme images

Show child attributes

edges.reward.items.achievements.details.light.primaryImageUrl

string | null

required

The url of the primary image for this theme mode

edges.reward.items.achievements.details.light.secondaryImageUrl

string | null

required

The url of the secondary image for this theme mode

edges.reward.items.achievements.details.dark

object

required

Dark theme images

Show child attributes

edges.reward.items.achievements.details.dark.primaryImageUrl

string | null

required

The url of the primary image for this theme mode

edges.reward.items.achievements.details.dark.secondaryImageUrl

string | null

required

The url of the secondary image for this theme mode

edges.reward.items.achievements.progressPeriod

enum<string>

required

The period over which progress is tracked/reset

Available options:

daily,

weekly,

monthly,

yearly,

open

edges.reward.items.achievements.displayMode

enum<string>

required

The display mode for the achievement. Useful to make the distinction between normal user achievments and achievments designed for implementing custom app functionality.

Available options:

default,

custom

edges.reward.items.achievements.tags

string[]

required

The ids of the tags on the achievement

edges.reward.items.achievements.campaigns

string[]

required

The ids of the campaigns on the achievement

edges.reward.items.achievements.criteria

Sum Condition Node · object

required

This represents a condition that must be met by a user for the achievement to be completed

Sum Condition Node
Count Condition Node
Logical Condition Node

Show child attributes

edges.reward.items.achievements.criteria.type

enum<string>

required

Identifies this node as a SumNode type, which is responsible for summing numeric attributes from events and comparing against a threshold

Available options:

sum

edges.reward.items.achievements.criteria.parameters

Sum Condition Node Parameters · object

required

Parameters for a sum condition node that define the attribute summation logic and threshold comparison

Show child attributes

edges.reward.items.achievements.criteria.parameters.query

string

required

Reference to the query alias that identifies which events should be included in the sum. This query must be defined in an EventQueryNode within the achievement's criteria array.

edges.reward.items.achievements.criteria.parameters.operator

enum<string>

required

Comparison operator that defines how to compare the summed value against the threshold value. For example, 'GreaterThan' would check if the sum exceeds the threshold.

Available options:

==,

!=,

>,

<,

>=,

<=

edges.reward.items.achievements.criteria.parameters.attribute

string

required

The specific event attribute whose values should be summed. This must be a numeric attribute present in the matched events.

Minimum string length: 1

edges.reward.items.achievements.criteria.parameters.value

number

required

The threshold value to compare the sum against. This represents the target number that the summed values will be compared to using the specified operator.

edges.reward.items.achievements.queries

Event Query Node · object[]

required

The event queries used to measure progress against this achievement's criteria

Show child attributes

edges.reward.items.achievements.queries.type

enum<string>

required

Identifies this node as an EventQueryNode type, which defines criteria for selecting events to be evaluated

Available options:

event

edges.reward.items.achievements.queries.alias

string

required

A unique identifier for this query that can be referenced by condition nodes. This allows the same event query to be reused across multiple conditions.

edges.reward.items.achievements.queries.parameters

Event Query Node Parameters · object

required

Parameters that define the criteria for matching and filtering events

Show child attributes

edges.reward.items.achievements.queries.parameters.eventName

string

required

The specific name of the event to match. This identifies the type of event that should be included in the achievement progress. When using a custom event, this should be the name of the event. When using a non-custom event, this should be the name of the event category and sub-category concatenated with an underscore.

edges.reward.items.achievements.queries.parameters.eventCategory

enum<string>

required

The category of events to match. This helps filter events by their broad classification within the system.

Available options:

achievement,

action,

auth,

blog,

challenge,

community,

custom,

game,

leaderboard,

organisation,

points,

post,

referral,

reward,

shop,

social,

social-connection,

streak,

user,

variable,

xp

edges.reward.items.achievements.queries.parameters.eventSubCategory

enum<string>

required

The sub-category of events to match. This provides more granular filtering within the selected event category.

Available options:

achievement-completion,

facebook-comment,

facebook-follow,

facebook-like,

image-analysis-object-detection,

image-analysis-receipt-detection,

instagram-follow,

instagram-like,

instagram-comment,

instagram-share,

instagram-post,

interaction-engage-with-content,

interaction-external-link,

interaction-image-upload,

interaction-spot-object,

platform-comment-on-post,

platform-complete-achievement,

platform-generative-action,

platform-like-post,

platform-play-game,

platform-validate-event,

question-multiple-choice,

question-open-ended,

question-rate-your-experience,

question-secret-access-code,

question-select-date,

question-select-from-images,

question-select-value-in-range,

question-select-from-list,

question-closed-ended,

question-vote,

spotify-follow,

spotify-listen,

spotify-save,

tiktok-follow,

tiktok-watch,

tiktok-post,

youtube-like,

youtube-comment,

youtube-subscribe,

action-completion,

skip-action,

42-school,

api-auth-link,

api-token-link,

apple,

asgardeo,

atlassian,

auth0,

authentik,

azure-ad-b2c,

azure-ad,

azure-devops,

battlenet,

beyondidentity,

box,

boxyhq-saml,

bungie,

click-up,

cognito,

coinbase,

descope,

discord,

dribbble,

dropbox,

duende-identity-server6,

email,

eveonline,

facebook,

faceit,

foursquare,

freshbooks,

fusionauth,

github,

gitlab,

google,

hubspot,

identity-server4,

instagram,

kakao,

keycloak,

line,

linkedin,

mailchimp,

mailru,

mastodon,

mattermost,

medium,

naver,

netlify,

notion,

okta,

onelogin,

organisation-oidc,

osso,

osu,

passage,

patreon,

pinterest,

pipedrive,

reddit,

salesforce,

slack,

spotify,

strava,

tiktok,

todoist,

trakt,

twitch,

twitter,

united-effects,

vk,

wikimedia,

wordpress,

workos,

yandex,

youtube,

zitadel,

zoho,

zoom,

blog-comment,

blog-like,

blog-share,

blog-view,

challenge-started,

challenge-completion,

challenge-unlock,

community-visit,

parental-approval-requested,

parental-approval-approved,

parental-approval-rejected,

custom,

game-started,

game-completed,

leaderboard-finish,

invite-admin-user,

points-credit,

points-spend,

post-comment,

post-like,

post-view,

reward-redemption,

reward-allocation-purchase,

reward-giveaway-winner,

reward-claim,

reward-distribution,

manual-distribution,

referral-link-used,

shop-purchase,

share-challenge-details,

share-challenge-results,

share-community,

share-reward,

share-post,

share-profile,

share-anything,

streak-extended,

profile-picture-added,

bio-added,

variable-captured,

xp-gained,

xp-total,

xp-leaderboard-topper

edges.reward.items.achievements.queries.parameters.eventSourceId

string | null

Optional identifier for the source of the events. When specified, only events from this source will count towards the achievement progress. For example, a challengeId, or another achievementId

edges.reward.items.achievements.queries.parameters.tags

string[] | null

Optional array of tag ids to filter events by. Only events with all specified tags will count towards the achievement progress.

edges.reward.items.achievements.queries.isCommunityScoped

boolean | null

default:true

Controls whether the query should only match events within the achievement's community context. When true (default), only community-specific events are included.

edges.reward.items.achievements.queryDescriptions

object

required

A map of query alias to user-readable descriptions, useful for displaying in the UI. Can be localised across additional languages.

Show child attributes

edges.reward.items.achievements.queryDescriptions.{key}

string

edges.reward.items.achievements.status

enum<string>

required

The status of the achievement

Available options:

archived,

draft,

expired,

live,

scheduled

edges.reward.items.achievements.availableAsTemplateForOrganisations

string[]

required

The organisations that the achievement is available as a template for

edges.reward.items.achievements.isGlobalTemplate

boolean

required

Whether the achievement is a global template

edges.reward.items.achievements.createdAt

string

required

When this achievement was created

edges.reward.items.achievements.updatedAt

string

required

When this achievement was last updated

edges.reward.items.achievements.userState

Achievement Node Progress · object

required

The current user's progress on this achievement

Show child attributes

edges.reward.items.achievements.userState.status

enum<string>

required

The status of the user's progress on this achievement

Available options:

completed,

in-progress,

locked,

not-started,

repeatable,

skipped

edges.reward.items.achievements.userState.timesCompleted

number

required

The number of times the achievement has been completed in the past by the user

Required range: x >= 0

edges.reward.items.achievements.userState.isClaimable

boolean

required

Whether the achievement is claimable by the user, if applicable

edges.reward.items.achievements.userState.isClaimed

boolean

required

Whether the achievement has been claimed by the user, if applicable

edges.reward.items.achievements.userState.updatedAt

string

required

When progress was last updated for this achievement

edges.reward.items.achievements.userState.earnedPoints

number

required

Points earned by the user for this achievement

Required range: x >= 0

edges.reward.items.achievements.userState.earnedRewardAssets

Reward Asset · object[]

required

Reward assets earned by the user for this achievement

Show child attributes

edges.reward.items.achievements.userState.earnedRewardAssets.id

string

required

edges.reward.items.achievements.userState.earnedRewardAssets.organisationId

string

required

edges.reward.items.achievements.userState.earnedRewardAssets.communityId

string

required

edges.reward.items.achievements.userState.earnedRewardAssets.rewardId

string

required

edges.reward.items.achievements.userState.earnedRewardAssets.allocationId

string

required

edges.reward.items.achievements.userState.earnedRewardAssets.userId

string

required

edges.reward.items.achievements.userState.earnedRewardAssets.details

Details · object

required

Used to describe an entity

Show child attributes

edges.reward.items.achievements.userState.earnedRewardAssets.details.title

string

required

The title of the entity

edges.reward.items.achievements.userState.earnedRewardAssets.details.description

string | null

required

The description of the entity

edges.reward.items.achievements.userState.earnedRewardAssets.details.light

object

required

Light theme images

Show child attributes

edges.reward.items.achievements.userState.earnedRewardAssets.details.light.primaryImageUrl

string | null

required

The url of the primary image for this theme mode

edges.reward.items.achievements.userState.earnedRewardAssets.details.light.secondaryImageUrl

string | null

required

The url of the secondary image for this theme mode

edges.reward.items.achievements.userState.earnedRewardAssets.details.dark

object

required

Dark theme images

Show child attributes

edges.reward.items.achievements.userState.earnedRewardAssets.details.dark.primaryImageUrl

string | null

required

The url of the primary image for this theme mode

edges.reward.items.achievements.userState.earnedRewardAssets.details.dark.secondaryImageUrl

string | null

required

The url of the secondary image for this theme mode

edges.reward.items.achievements.userState.earnedRewardAssets.redeemable

Reward Asset Redeemable Rich Text · object

required

A reward asset redeemable

Reward Asset Redeemable Rich Text
Reward Asset Redeemable Code
RewardAssetRedeemableBadge

Show child attributes

edges.reward.items.achievements.userState.earnedRewardAssets.redeemable.type

enum<string>

required

Available options:

rich-text

edges.reward.items.achievements.userState.earnedRewardAssets.redeemable.additionalInformation

Variable Config Reference · object[]

required

Show child attributes

edges.reward.items.achievements.userState.earnedRewardAssets.redeemable.additionalInformation.variableConfigId

string

required

The ID of the variable config that defines the data type, validation rules, and UI rendering

edges.reward.items.achievements.userState.earnedRewardAssets.redeemable.additionalInformation.required

boolean

required

Whether this variable must be filled out by the user before proceeding

edges.reward.items.achievements.userState.earnedRewardAssets.redeemable.additionalInformation.position

number

required

The display order position of this variable in the form or UI

Required range: x >= 1

edges.reward.items.achievements.userState.earnedRewardAssets.redeemable.content

string

required

edges.reward.items.achievements.userState.earnedRewardAssets.redeemable.instructions

string | null

Instructions for redeeming this reward. HTML is supported.

edges.reward.items.achievements.userState.earnedRewardAssets.redeemable.instructionsImageUrl

string | null

The URL of an image to display with the instructions

edges.reward.items.achievements.userState.earnedRewardAssets.redeemable.supportEmail

string<email> | null

The email address of the support team

edges.reward.items.achievements.userState.earnedRewardAssets.redeemable.supportPhoneNumber

string | null

The phone number of the support team

edges.reward.items.achievements.userState.earnedRewardAssets.redeemable.supportUrl

string | null

The URL of the support team

edges.reward.items.achievements.userState.earnedRewardAssets.redeemable.redeemByDate

string | null

edges.reward.items.achievements.userState.earnedRewardAssets.eventCategory

enum<string>

required

Available options:

achievement,

action,

auth,

blog,

challenge,

community,

custom,

game,

leaderboard,

organisation,

points,

post,

referral,

reward,

shop,

social,

social-connection,

streak,

user,

variable,

xp

edges.reward.items.achievements.userState.earnedRewardAssets.eventSubCategory

enum<string>

required

Available options:

achievement-completion,

facebook-comment,

facebook-follow,

facebook-like,

image-analysis-object-detection,

image-analysis-receipt-detection,

instagram-follow,

instagram-like,

instagram-comment,

instagram-share,

instagram-post,

interaction-engage-with-content,

interaction-external-link,

interaction-image-upload,

interaction-spot-object,

platform-comment-on-post,

platform-complete-achievement,

platform-generative-action,

platform-like-post,

platform-play-game,

platform-validate-event,

question-multiple-choice,

question-open-ended,

question-rate-your-experience,

question-secret-access-code,

question-select-date,

question-select-from-images,

question-select-value-in-range,

question-select-from-list,

question-closed-ended,

question-vote,

spotify-follow,

spotify-listen,

spotify-save,

tiktok-follow,

tiktok-watch,

tiktok-post,

youtube-like,

youtube-comment,

youtube-subscribe,

action-completion,

skip-action,

42-school,

api-auth-link,

api-token-link,

apple,

asgardeo,

atlassian,

auth0,

authentik,

azure-ad-b2c,

azure-ad,

azure-devops,

battlenet,

beyondidentity,

box,

boxyhq-saml,

bungie,

click-up,

cognito,

coinbase,

descope,

discord,

dribbble,

dropbox,

duende-identity-server6,

email,

eveonline,

facebook,

faceit,

foursquare,

freshbooks,

fusionauth,

github,

gitlab,

google,

hubspot,

identity-server4,

instagram,

kakao,

keycloak,

line,

linkedin,

mailchimp,

mailru,

mastodon,

mattermost,

medium,

naver,

netlify,

notion,

okta,

onelogin,

organisation-oidc,

osso,

osu,

passage,

patreon,

pinterest,

pipedrive,

reddit,

salesforce,

slack,

spotify,

strava,

tiktok,

todoist,

trakt,

twitch,

twitter,

united-effects,

vk,

wikimedia,

wordpress,

workos,

yandex,

youtube,

zitadel,

zoho,

zoom,

blog-comment,

blog-like,

blog-share,

blog-view,

challenge-started,

challenge-completion,

challenge-unlock,

community-visit,

parental-approval-requested,

parental-approval-approved,

parental-approval-rejected,

custom,

game-started,

game-completed,

leaderboard-finish,

invite-admin-user,

points-credit,

points-spend,

post-comment,

post-like,

post-view,

reward-redemption,

reward-allocation-purchase,

reward-giveaway-winner,

reward-claim,

reward-distribution,

manual-distribution,

referral-link-used,

shop-purchase,

share-challenge-details,

share-challenge-results,

share-community,

share-reward,

share-post,

share-profile,

share-anything,

streak-extended,

profile-picture-added,

bio-added,

variable-captured,

xp-gained,

xp-total,

xp-leaderboard-topper

edges.reward.items.achievements.userState.earnedRewardAssets.tags

string[]

required

edges.reward.items.achievements.userState.earnedRewardAssets.campaigns

string[]

required

edges.reward.items.achievements.userState.earnedRewardAssets.metadata

object

required

Additional metadata inherited from the reward

Show child attributes

edges.reward.items.achievements.userState.earnedRewardAssets.metadata.{key}

edges.reward.items.achievements.userState.earnedRewardAssets.createdAt

string

required

edges.reward.items.achievements.userState.earnedRewardAssets.updatedAt

string

required

edges.reward.items.achievements.userState.earnedRewardAssets.additionalCommunityIds

string[]

required

Additional communities this reward asset belongs to/is available in

edges.reward.items.achievements.userState.earnedRewardAssets.eventSourceId

string | null

edges.reward.items.achievements.userState.earnedRewardAssets.claimedAt

string | null

edges.reward.items.achievements.userState.earnedRewardAssets.redeemedAt

string | null

edges.reward.items.achievements.userState.earnedRewardAssets.expiresAt

string | null

edges.reward.items.achievements.userState.earnedRewardEntries

Reward Entry · object[]

required

Reward entries earned by the user for this achievement

Show child attributes

edges.reward.items.achievements.userState.earnedRewardEntries.id

string

required

edges.reward.items.achievements.userState.earnedRewardEntries.organisationId

string

required

edges.reward.items.achievements.userState.earnedRewardEntries.communityId

string

required

edges.reward.items.achievements.userState.earnedRewardEntries.rewardId

string

required

edges.reward.items.achievements.userState.earnedRewardEntries.userId

string

required

edges.reward.items.achievements.userState.earnedRewardEntries.details

Details · object

required

Used to describe an entity

Show child attributes

edges.reward.items.achievements.userState.earnedRewardEntries.details.title

string

required

The title of the entity

edges.reward.items.achievements.userState.earnedRewardEntries.details.description

string | null

required

The description of the entity

edges.reward.items.achievements.userState.earnedRewardEntries.details.light

object

required

Light theme images

Show child attributes

edges.reward.items.achievements.userState.earnedRewardEntries.details.light.primaryImageUrl

string | null

required

The url of the primary image for this theme mode

edges.reward.items.achievements.userState.earnedRewardEntries.details.light.secondaryImageUrl

string | null

required

The url of the secondary image for this theme mode

edges.reward.items.achievements.userState.earnedRewardEntries.details.dark

object

required

Dark theme images

Show child attributes

edges.reward.items.achievements.userState.earnedRewardEntries.details.dark.primaryImageUrl

string | null

required

The url of the primary image for this theme mode

edges.reward.items.achievements.userState.earnedRewardEntries.details.dark.secondaryImageUrl

string | null

required

The url of the secondary image for this theme mode

edges.reward.items.achievements.userState.earnedRewardEntries.totalEntries

number

required

edges.reward.items.achievements.userState.earnedRewardEntries.entries

Reward Entry Reference · object[]

required

Show child attributes

edges.reward.items.achievements.userState.earnedRewardEntries.entries.allocationId

string

required

edges.reward.items.achievements.userState.earnedRewardEntries.entries.amount

number

required

edges.reward.items.achievements.userState.earnedRewardEntries.entries.createdAt

string

required

edges.reward.items.achievements.userState.earnedRewardEntries.tags

string[]

required

edges.reward.items.achievements.userState.earnedRewardEntries.campaigns

string[]

required

edges.reward.items.achievements.userState.earnedRewardEntries.createdAt

string

required

edges.reward.items.achievements.userState.earnedRewardEntries.updatedAt

string

required

edges.reward.items.achievements.userState.earnedRewardEntries.additionalCommunityIds

string[]

required

Additional communities this reward entry belongs to/is available in

edges.reward.items.achievements.userState.earnedRewardEntries.status

enum<string>

required

The status of the reward entry

Available options:

pending,

unchecked,

won,

lost

edges.reward.items.achievements.userState.earnedRewardEntries.rewardAssetIds

string[] | null

edges.reward.items.achievements.userState.earnedRewardEntries.checkByDate

string | null

edges.reward.items.achievements.userState.earnedRewardEntries.checkedAt

string | null

edges.reward.items.achievements.userState.earnedRewardEntries.drawnAt

string | null

edges.reward.items.achievements.userState.earnedRewardEntries.rewardAssets

Reward Asset · object[] | null

The reward assets if the user won

Show child attributes

edges.reward.items.achievements.userState.earnedRewardEntries.rewardAssets.id

string

required

edges.reward.items.achievements.userState.earnedRewardEntries.rewardAssets.organisationId

string

required

edges.reward.items.achievements.userState.earnedRewardEntries.rewardAssets.communityId

string

required

edges.reward.items.achievements.userState.earnedRewardEntries.rewardAssets.rewardId

string

required

edges.reward.items.achievements.userState.earnedRewardEntries.rewardAssets.allocationId

string

required

edges.reward.items.achievements.userState.earnedRewardEntries.rewardAssets.userId

string

required

edges.reward.items.achievements.userState.earnedRewardEntries.rewardAssets.details

Details · object

required

Used to describe an entity

Show child attributes

edges.reward.items.achievements.userState.earnedRewardEntries.rewardAssets.details.title

string

required

The title of the entity

edges.reward.items.achievements.userState.earnedRewardEntries.rewardAssets.details.description

string | null

required

The description of the entity

edges.reward.items.achievements.userState.earnedRewardEntries.rewardAssets.details.light

object

required

Light theme images

Show child attributes

edges.reward.items.achievements.userState.earnedRewardEntries.rewardAssets.details.light.primaryImageUrl

string | null

required

The url of the primary image for this theme mode

edges.reward.items.achievements.userState.earnedRewardEntries.rewardAssets.details.light.secondaryImageUrl

string | null

required

The url of the secondary image for this theme mode

edges.reward.items.achievements.userState.earnedRewardEntries.rewardAssets.details.dark

object

required

Dark theme images

Show child attributes

edges.reward.items.achievements.userState.earnedRewardEntries.rewardAssets.details.dark.primaryImageUrl

string | null

required

The url of the primary image for this theme mode

edges.reward.items.achievements.userState.earnedRewardEntries.rewardAssets.details.dark.secondaryImageUrl

string | null

required

The url of the secondary image for this theme mode

edges.reward.items.achievements.userState.earnedRewardEntries.rewardAssets.redeemable

Reward Asset Redeemable Rich Text · object

required

A reward asset redeemable

Reward Asset Redeemable Rich Text
Reward Asset Redeemable Code
RewardAssetRedeemableBadge

Show child attributes

edges.reward.items.achievements.userState.earnedRewardEntries.rewardAssets.redeemable.type

enum<string>

required

Available options:

rich-text

edges.reward.items.achievements.userState.earnedRewardEntries.rewardAssets.redeemable.additionalInformation

Variable Config Reference · object[]

required

Show child attributes

edges.reward.items.achievements.userState.earnedRewardEntries.rewardAssets.redeemable.additionalInformation.variableConfigId

string

required

The ID of the variable config that defines the data type, validation rules, and UI rendering

edges.reward.items.achievements.userState.earnedRewardEntries.rewardAssets.redeemable.additionalInformation.required

boolean

required

Whether this variable must be filled out by the user before proceeding

edges.reward.items.achievements.userState.earnedRewardEntries.rewardAssets.redeemable.additionalInformation.position

number

required

The display order position of this variable in the form or UI

Required range: x >= 1

edges.reward.items.achievements.userState.earnedRewardEntries.rewardAssets.redeemable.content

string

required

edges.reward.items.achievements.userState.earnedRewardEntries.rewardAssets.redeemable.instructions

string | null

Instructions for redeeming this reward. HTML is supported.

edges.reward.items.achievements.userState.earnedRewardEntries.rewardAssets.redeemable.instructionsImageUrl

string | null

The URL of an image to display with the instructions

edges.reward.items.achievements.userState.earnedRewardEntries.rewardAssets.redeemable.supportEmail

string<email> | null

The email address of the support team

edges.reward.items.achievements.userState.earnedRewardEntries.rewardAssets.redeemable.supportPhoneNumber

string | null

The phone number of the support team

edges.reward.items.achievements.userState.earnedRewardEntries.rewardAssets.redeemable.supportUrl

string | null

The URL of the support team

edges.reward.items.achievements.userState.earnedRewardEntries.rewardAssets.redeemable.redeemByDate

string | null

edges.reward.items.achievements.userState.earnedRewardEntries.rewardAssets.eventCategory

enum<string>

required

Available options:

achievement,

action,

auth,

blog,

challenge,

community,

custom,

game,

leaderboard,

organisation,

points,

post,

referral,

reward,

shop,

social,

social-connection,

streak,

user,

variable,

xp

edges.reward.items.achievements.userState.earnedRewardEntries.rewardAssets.eventSubCategory

enum<string>

required

Available options:

achievement-completion,

facebook-comment,

facebook-follow,

facebook-like,

image-analysis-object-detection,

image-analysis-receipt-detection,

instagram-follow,

instagram-like,

instagram-comment,

instagram-share,

instagram-post,

interaction-engage-with-content,

interaction-external-link,

interaction-image-upload,

interaction-spot-object,

platform-comment-on-post,

platform-complete-achievement,

platform-generative-action,

platform-like-post,

platform-play-game,

platform-validate-event,

question-multiple-choice,

question-open-ended,

question-rate-your-experience,

question-secret-access-code,

question-select-date,

question-select-from-images,

question-select-value-in-range,

question-select-from-list,

question-closed-ended,

question-vote,

spotify-follow,

spotify-listen,

spotify-save,

tiktok-follow,

tiktok-watch,

tiktok-post,

youtube-like,

youtube-comment,

youtube-subscribe,

action-completion,

skip-action,

42-school,

api-auth-link,

api-token-link,

apple,

asgardeo,

atlassian,

auth0,

authentik,

azure-ad-b2c,

azure-ad,

azure-devops,

battlenet,

beyondidentity,

box,

boxyhq-saml,

bungie,

click-up,

cognito,

coinbase,

descope,

discord,

dribbble,

dropbox,

duende-identity-server6,

email,

eveonline,

facebook,

faceit,

foursquare,

freshbooks,

fusionauth,

github,

gitlab,

google,

hubspot,

identity-server4,

instagram,

kakao,

keycloak,

line,

linkedin,

mailchimp,

mailru,

mastodon,

mattermost,

medium,

naver,

netlify,

notion,

okta,

onelogin,

organisation-oidc,

osso,

osu,

passage,

patreon,

pinterest,

pipedrive,

reddit,

salesforce,

slack,

spotify,

strava,

tiktok,

todoist,

trakt,

twitch,

twitter,

united-effects,

vk,

wikimedia,

wordpress,

workos,

yandex,

youtube,

zitadel,

zoho,

zoom,

blog-comment,

blog-like,

blog-share,

blog-view,

challenge-started,

challenge-completion,

challenge-unlock,

community-visit,

parental-approval-requested,

parental-approval-approved,

parental-approval-rejected,

custom,

game-started,

game-completed,

leaderboard-finish,

invite-admin-user,

points-credit,

points-spend,

post-comment,

post-like,

post-view,

reward-redemption,

reward-allocation-purchase,

reward-giveaway-winner,

reward-claim,

reward-distribution,

manual-distribution,

referral-link-used,

shop-purchase,

share-challenge-details,

share-challenge-results,

share-community,

share-reward,

share-post,

share-profile,

share-anything,

streak-extended,

profile-picture-added,

bio-added,

variable-captured,

xp-gained,

xp-total,

xp-leaderboard-topper

edges.reward.items.achievements.userState.earnedRewardEntries.rewardAssets.tags

string[]

required

edges.reward.items.achievements.userState.earnedRewardEntries.rewardAssets.campaigns

string[]

required

edges.reward.items.achievements.userState.earnedRewardEntries.rewardAssets.metadata

object

required

Additional metadata inherited from the reward

Show child attributes

edges.reward.items.achievements.userState.earnedRewardEntries.rewardAssets.metadata.{key}

edges.reward.items.achievements.userState.earnedRewardEntries.rewardAssets.createdAt

string

required

edges.reward.items.achievements.userState.earnedRewardEntries.rewardAssets.updatedAt

string

required

edges.reward.items.achievements.userState.earnedRewardEntries.rewardAssets.additionalCommunityIds

string[]

required

Additional communities this reward asset belongs to/is available in

edges.reward.items.achievements.userState.earnedRewardEntries.rewardAssets.eventSourceId

string | null

edges.reward.items.achievements.userState.earnedRewardEntries.rewardAssets.claimedAt

string | null

edges.reward.items.achievements.userState.earnedRewardEntries.rewardAssets.redeemedAt

string | null

edges.reward.items.achievements.userState.earnedRewardEntries.rewardAssets.expiresAt

string | null

edges.reward.items.achievements.userState.earnedXp

number

required

XP earned by the user for this achievement

Required range: x >= 0

edges.reward.items.achievements.userState.type

enum<string>

required

The type of the progress node, which determines how the progress is calculated

Available options:

sum,

count,

logical_and,

logical_or,

unknown

edges.reward.items.achievements.userState.isComplete

boolean

required

Whether this node's condition has been met by the user

edges.reward.items.achievements.userState.currentValue

number

required

Current progress value for this node

edges.reward.items.achievements.userState.targetValue

number

required

Target value to reach for this node

edges.reward.items.achievements.userState.conditions

array

required

Progress of any child conditions, in the same tree structure as the achievement's criteria conditions

edges.reward.items.achievements.userState.completedAt

string | null

When the achievement was completed by the user, if applicable

edges.reward.items.achievements.userState.progressResetsAt

string | null

When the achievement progress will next reset, if applicable

edges.reward.items.achievements.stats

object

required

Statistics about this achievement

Show child attributes

edges.reward.items.achievements.stats.completedCount

number

required

Number of users who have completed this achievement

Required range: x >= 0

edges.reward.items.achievements.reward

Entity Reward Distribution · object

required

A reward distribution for an entity

Show child attributes

edges.reward.items.achievements.reward.points

number

required

Number of points awarded

Required range: x >= 0

edges.reward.items.achievements.reward.completionXp

number

required

Amount of XP awarded for completion

Required range: x >= 0

edges.reward.items.achievements.reward.items

Reward Distribution Item · object[]

required

Reward items available

Show child attributes

edges.reward.items.achievements.reward.items.id

string

required

The unique identifier of the reward

edges.reward.items.achievements.reward.items.details

Details · object

required

Used to describe an entity

Show child attributes

edges.reward.items.achievements.reward.items.details.title

string

required

The title of the entity

edges.reward.items.achievements.reward.items.details.description

string | null

required

The description of the entity

edges.reward.items.achievements.reward.items.details.light

object

required

Light theme images

Show child attributes

edges.reward.items.achievements.reward.items.details.light.primaryImageUrl

string | null

required

The url of the primary image for this theme mode

edges.reward.items.achievements.reward.items.details.light.secondaryImageUrl

string | null

required

The url of the secondary image for this theme mode

edges.reward.items.achievements.reward.items.details.dark

object

required

Dark theme images

Show child attributes

edges.reward.items.achievements.reward.items.details.dark.primaryImageUrl

string | null

required

The url of the primary image for this theme mode

edges.reward.items.achievements.reward.items.details.dark.secondaryImageUrl

string | null

required

The url of the secondary image for this theme mode

edges.reward.items.achievements.reward.items.type

enum<string>

required

The type of reward allocation (assets or entries)

Available options:

assets,

entries

edges.reward.items.achievements.reward.items.amountToDistribute

number

required

Amount of this reward to distribute

Required range: x >= 0

edges.reward.items.achievements.reward.items.totalSupply

required

Total supply available for this reward

Required range: x >= 0

edges.reward.items.achievements.reward.items.remainingSupply

required

Number of items still available for distribution

Required range: x >= 0

edges.reward.items.achievements.reward.rewardSelectionMethod

enum<string> | null

required

Method for reward selection

Available options:

all,

priority,

random,

select,

edges.reward.items.achievements.reward.numberOfRewardsToReceive

number

required

Number of rewards to receive

Required range: x >= 0

edges.reward.items.achievements.reward.distributionEventId

string | null

required

ID of the distribution event

edges.reward.items.achievements.communityId

string | null

The id of the community this achievement belongs to

edges.reward.items.achievements.featured

boolean | null

Whether the achievement is featured

edges.reward.items.achievements.startsAt

string | null

When this achievement becomes available to the user

edges.reward.items.achievements.expiresAt

string | null

When this achievement expires

edges.reward.items.initialAssetSupply

required

Initial total supply of assets configured for this reward when created

Required range: x >= 0

edges.reward.items.initialEntrySupply

required

Initial total supply of entries configured for this reward when created

Required range: x >= 0

edges.reward.items.distributedAssetCount

number

required

Number of assets that have been distributed for this reward

Required range: x >= 0

edges.reward.items.distributedEntryCount

number

required

Number of entries that have been distributed for this reward

Required range: x >= 0

edges.reward.items.remainingAssetSupply

required

Number of assets still available for distribution

Required range: x >= 0

edges.reward.items.remainingEntrySupply

required

Number of entries still available for distribution

Required range: x >= 0

edges.reward.items.remainingShopAssetSupply

required

Number of assets still available for purchase through the shop

Required range: x >= 0

edges.reward.items.remainingShopEntrySupply

required

Number of entries still available for purchase through the shop

Required range: x >= 0

edges.reward.items.userEntryCount

number

default:0

required

Number of entries the current user has for this reward

Required range: x >= 0

edges.reward.items.userAssetCount

number

default:0

required

Number of assets the current user has for this reward

Required range: x >= 0

edges.reward.items.featured

boolean | null

Whether this reward is featured

edges.reward.items.drawsAt

string | null

When this reward giveaway will be drawn

edges.reward.items.startsAt

string | null

When this reward becomes available

edges.reward.items.expiresAt

string | null

When this reward expires (or giveaway takes place)

edges.reward.rewardSelectionMethod

enum<string> | null

required

The method used to select which rewards will be given (all, priority, or random)

Available options:

all,

priority,

random,

select,

edges.reward.numberOfRewardsToReceive

number | null

required

The number of different rewards that will be given based on the selection method

Required range: x >= 0

edges.description

string | null

edges.expiresAt

string | null

Achievements

Action Participations

Actions

Auth Config

Campaigns

Challenge Groups

Challenges

Comments

Communities

Events

Feature Flags

Languages

Leaderboards

Legal Policies

Me

Posts

Rewards

Tags

Themes

Third Party Config

Variables

Authorizations

Headers

Query Parameters

Response