Get info on given quest

GET 
/quest/:questId

Get info on given quest

Request

Path Parameters

questId questIdrequired

The questId to grab data about

Responses

200

Quest successfully retrieved

application/json

Schema

Schema

userQuestCount integer

Number of times this quest has been completed.

maxStage integer

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

name questName (string)required

Possible values: <= 64 characters

Name of the quest

descriptions string

Detailed descriptions of the different stages/applications of the quest

userQuestsLimit integer

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

data string

Quest-specific data in JSON format

referrerQuestId string

Unique identifier for the referrer quest

prerequisites questId (string)[]nullable

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

state questState (string)

Possible values: [open, closed]

id questId (string)

Unique identifier for Quest

questTypeId stringrequired

Unique identifier for the QuestType

expiresAt date-timenullable

Expiration date for the quest

myUserQuestCount integer

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

points integerrequired

Possible values: <= 1000000

The amount of points you gain after finishing the quest

thumbnail stringnullable

URL to the quest's thumbnail image

projectId projectId (string)required

Unique identifier for Project

periodic questPeriodic (string)

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

refereeQuestId stringnullable

Unique identifier for the referee quest

rankOrder integer

The order in which the quest should be displayed

createdAt date-time

Time representation of entity creation

Example (from schema)

{
  "userQuestCount": 1,
  "maxStage": 5,
  "name": "Game referral",
  "descriptions": "{\"short\":\"wishlist BF4 in order to obtain your points\",\"pre\":[\"stage 1 desc\",\"stage 2 desc\"]}",
  "userQuestsLimit": 3,
  "data": "string",
  "referrerQuestId": "Q3b19Z1n",
  "prerequisites": [
    "q3b19Z1n"
  ],
  "state": "open",
  "id": "q3b19Z1n",
  "questTypeId": "Q3b19Z1n",
  "expiresAt": "2025-01-01T09:00:00.00Z",
  "myUserQuestCount": 2,
  "points": 50,
  "thumbnail": "https://file.playmakers.co/p2Duhf5N6/aUv0OhmsR.jpg",
  "projectId": "p2Duhf5N6",
  "periodic": "daily",
  "refereeQuestId": "Q3b19Z1n",
  "rankOrder": 1,
  "createdAt": "2024-01-01T09:00:00.00Z"
}

403

Forbidden

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "string"
}

Example

{
  "error": "Forbidden access"
}

404

NotFound

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "string"
}

Example

{
  "error": "A mandatory item was not found"
}

500

Internal Server Error

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "string"
}

Example

{
  "error": "Internal Server Error"
}

default

Unexpected error

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "string"
}

Example

{
  "error": "An unexpected error occured"
}

Loading...