Skip to main content

Get a reward by ID

GET 
/reward/:rewardId

Get a reward by ID

Request​

Path Parameters

    rewardId rewardIdrequired

    The unique identifier for the reward

Responses​

Reward retrieved successfully

Schema

    createdAt date-time

    Time representation of entity creation

    maxClaims integernullable

    Maximum number of times this reward can be redeemed.

    name rewardName (string)required

    Possible values: <= 32 characters

    Name of the reward

    requiredPoints integer

    Possible values: <= 1000000

    Points required to claim the reward

    description string

    Detailed description of the reward

    projectId stringrequired

    ID of the project associated with the reward

    userRewardCount integer

    Number of times this reward has been redeemed.

    rewardTypeId rewardTypeId (string)required

    Unique identifier for RewardType

    rankOrder integer

    The order in which the reward should be displayed

    myUserRewardCount integer

    Number of times this reward has been redeemed by the current user.

    id rewardId (string)

    Unique identifier for Reward

    thumbnail urinullable

    Optional URL for the reward's thumbnail image.

    data stringnullable

    Additional JSON metadata for triggers, actions or general easy-access data

    userRewardsLimit integer

    Maximum allowed number of times for the reward to be redeemed by a single user

    expiresAt date-timenullable

    Expiration date for special rewards

Loading...