Skip to main content

Fetch quests for a project

GET 
/quests/by/project/:projectId

Fetch quests for a project

Request​

Path Parameters

    projectId projectIdrequired

    The projectId to get quests of

Query Parameters

    startDate date-time

    Search by start date

    endDate date-time

    Search by end date

    sortBy string

    Possible values: [createdAt, popularity, points, rankOrder]

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

    sortOrder string

    Possible values: [asc, desc]

    Default value: desc

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

    stageFilter string

    Possible values: [all, stage, nonStage]

    Specify whether to fetch stageQuests or not.

    state string

    The state of the fetched quests

    category string

    Field to filter results by quest categories (e.g. steam, youtube, tiktok).

    name string

    Field to filter results by quest function names (e.g. wishlist, tweet, ownedGame).

Responses​

Fetch quests of a project

Schema

  • Array [

    • maxStage integer

    The index of the last stage (0 if not a StagesQuest)

    data string

    Quest-specific data in JSON format

    userQuestsLimit integer

    Maximum allowed number of times for the quest to be completed by a single user

    thumbnail stringnullable

    URL to the quest's thumbnail image

    userQuestCount integer

    Number of times this quest has been completed.

    prerequisites questId (string)[]nullable

    List of prerequisite quests that must be completed before starting this quest

    expiresAt date-timenullable

    Expiration date for the quest

    questTypeId stringrequired

    Unique identifier for the QuestType

    rankOrder integer

    The order in which the quest should be displayed

    referrerQuestId string

    Unique identifier for the referrer quest

    name questName (string)required

    Possible values: <= 64 characters

    Name of the quest

    state questState (string)

    Possible values: [open, closed]

    refereeQuestId stringnullable

    Unique identifier for the referee quest

    periodic questPeriodic (string)

    Possible values: [daily, weekly, monthly, hourly]

    descriptions string

    Detailed descriptions of the different stages/applications of the quest

    createdAt date-time

    Time representation of entity creation

    myUserQuestCount integer

    Number of times this quest has been completed by the current user

    projectId projectId (string)required

    Unique identifier for Project

    points integerrequired

    Possible values: <= 1000000

    The amount of points you gain after finishing the quest

    id questId (string)

    Unique identifier for Quest

  • ]

Loading...