Skip to main content

Get all rewards by projectId

GET 
/rewards/by/project/:projectId

Get all rewards by projectId

Request​

Path Parameters

    projectId projectIdrequired

    The unique identifier for the project

Query Parameters

    startDate date-time

    Search by start date

    endDate date-time

    Search by end date

    page integer

    Possible values: >= 1

    Default value: 1

    Specify the page number for pagination (default is 1).

    limit integer

    Default value: 10

    Specify the number of projects per page (default is 10, 0 gets all results).

    sortBy string

    Possible values: [createdAt, claimedAt]

    Field to order the results by (e.g., 'createdAt', 'numMonthlyUsers'). Default is 'createdAt'.

    sortOrder string

    Possible values: [asc, desc]

    Default value: desc

    'asc' for ascending or 'desc' for descending order. Default is 'desc'.

Responses​

Rewards retrieved successfully

Schema

  • Array [

    • description stringrequired

    Detailed description of the reward

    thumbnail urinullable

    Optional URL for the reward's thumbnail image.

    id rewardId (string)

    Unique identifier for Reward

    projectId stringrequired

    ID of the project associated with the reward

    expiresAt date-timenullable

    Expiration date for special rewards

    rewardTypeId rewardTypeId (string)required

    Unique identifier for RewardType

    userRewardCount integer

    Number of times this reward has been redeemed.

    myUserRewardCount integer

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

    requiredPoints integer

    Possible values: <= 1000000

    Points required to claim the reward

    name stringrequired

    Name of the reward

    createdAt date-time

    Time representation of entity creation

    data stringnullable

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

    maxClaims integernullable

    Maximum number of times this reward can be redeemed.

  • ]

Loading...