Skip to main content

Get all userQuests in a project by projectId

GET 
/userQuests/by/project/:projectId

Get all userQuests in a project by projectId

Request​

Path Parameters

    projectId projectIdrequired

    The unique identifier for the project

Query Parameters

    state string

    Possible values: [default, archived, cancelled]

    The state of the userQuest.

    startDate date-time

    Search by start date since createdAt

    endDate date-time

    Search by end date until createdAt

    stageFilter string

    Possible values: [all, stage, nonStage]

    Specify whether to fetch userQuests of stagesQuests or not.

    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]

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

    sortOrder string

    Possible values: [asc, desc]

    Default value: desc

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

Responses​

UserQuests retrieved successfully

Schema

  • Array [

    • lastComputedAt date-time

    Time representation of the last computation of computedData

    createdAt date-time

    Time representation of userQuest creation

    stage integer

    The stage upon which points were granted

    questId questId (string)

    Unique identifier for Quest

    creatorData string

    Optional json data provided by the user

    id userQuestId (string)

    Unique identifier for UserQuest

    state userQuestState (string)

    Possible values: [default, archived, cancelled]

    userId uuid

    Unique identifier

    computedData string

    Optional json data generated internally

  • ]

Loading...