Fetch quests for a project
GET/quests/by/project/:projectId
Fetch quests for a project
Request
Path Parameters
The projectId to get quests of
Query Parameters
Search by start date
Search by end date
Possible values: [createdAt
, popularity
, points
, rankOrder
]
Field to order the results by (e.g., 'createdAt', 'points'). Default is 'createdAt'.
Possible values: [asc
, desc
]
Default value: desc
'asc' for ascending or 'desc' for descending order. Default is 'desc'.
Possible values: [all
, stage
, nonStage
]
Specify whether to fetch stageQuests or not.
The state of the fetched quests
Field to filter results by quest categories (e.g. steam, youtube, tiktok).
Field to filter results by quest function names (e.g. wishlist, tweet, ownedGame).
Responses
- 200
- default
Fetch quests of a project
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
Possible values: <= 64 characters
Name of the quest
Unique identifier for Quest
Unique identifier for Project
The order in which the quest should be displayed
Maximum allowed number of times for the quest to be completed by a single user
Expiration date for the quest
Detailed descriptions of the different stages/applications of the quest
Possible values: [daily
, weekly
, monthly
, hourly
]
Possible values: <= 1000000
The amount of points you gain after finishing the quest
Time representation of entity creation
Number of times this quest has been completed.
List of prerequisite quests that must be completed before starting this quest
Number of times this quest has been completed by the current user
Unique identifier for the referrer quest
URL to the quest's thumbnail image
Possible values: [open
, closed
]
Unique identifier for the referee quest
Quest-specific data in JSON format
The index of the last stage (0 if not a StagesQuest)
Unique identifier for the QuestType
[
{
"name": "Game referral",
"id": "q3b19Z1n",
"projectId": "p2Duhf5N6",
"rankOrder": 1,
"userQuestsLimit": 3,
"expiresAt": "2025-01-01T09:00:00.00Z",
"descriptions": "{\"short\":\"wishlist BF4 in order to obtain your points\",\"pre\":[\"stage 1 desc\",\"stage 2 desc\"]}",
"periodic": "daily",
"points": 50,
"createdAt": "2024-01-01T09:00:00.00Z",
"userQuestCount": 1,
"prerequisites": [
"q3b19Z1n"
],
"myUserQuestCount": 2,
"referrerQuestId": "Q3b19Z1n",
"thumbnail": "https://file.playmakers.co/p2Duhf5N6/aUv0OhmsR.jpg",
"state": "open",
"refereeQuestId": "Q3b19Z1n",
"data": "string",
"maxStage": 5,
"questTypeId": "Q3b19Z1n"
}
]
Unexpected error
- application/json
- Schema
- Example (from schema)
- Example
Schema
{
"error": "string"
}
{
"error": "An unexpected error occured"
}