Skip to main content
GET
cURL

Headers

x-api-key
string<uuid>
required

Your community API key

Path Parameters

questId
string<uuid>
required

ID of a quest to query

Response

200 - application/json

Quest has been retrieved

id
string
required

Unique quest ID.

status
enum<string>
required

Quest status.

Available options:
DRAFT,
TEMPLATE,
ACTIVE,
PAUSED,
REVIEW,
ENDED,
ARCHIVED
name
string
required

Quest name.

Maximum string length: 48
shortDescription
string
required

Quest intro (plain text only).

Maximum string length: 256
fullDescription
string
required

Quest instructions (supports markdown).

Maximum string length: 4096
createdAt
number
required

Quest creation UNIX timestamp.

recurrence
enum<string>
required

Quest recurrence type.

Available options:
ONCE,
DAILY,
WEEKLY,
MONTHLY,
CUSTOM
visibility
enum<string>
required

Quest visibility type.

Available options:
PRIVATE,
PUBLIC,
SHARED
iteration
integer
required

Current quest round.

Required range: 1 <= x <= 9007199254740991
iterationCompletions
number[]
required

Quest completions per iteration.

totalCompletionCount
number
required

Total quest completions count.

tasks
object[]
required

Quest tasks and requirements.

Maximum array length: 32
communityId
string
required

ID of the community this quest belongs to

rewards
(Fixed · object | Random · object | Shared · object)[]
required

Rewards that can be obtained by completing the quest.

Maximum array length: 4
versionId
string | null

ID of the latest editable quest version.

creatorId
string | null

ID of the user who created this quest.

bannerUrl
string<uri> | null

Link to a banner image for the quest.

startTime
number | null

Quest start time UNIX timestamp.

endTime
number | null

Quest end time UNIX timestamp.

recurrenceInterval
number | null

Quest interval between rounds, or its duration for ONCE recurrence type.

Required range: 3600000 <= x <= 31536000000
nextIterationAt
number | null

Next quest round start time UNIX timestamp.

maxIterations
integer | null

Maximum number of quest rounds.

Required range: 1 <= x <= 9007199254740991
maxIterationCompletions
integer | null

Maximum number of completions per quest round.

Required range: 1 <= x <= 9007199254740991
maxAllowedStreakGap
integer

Maximum number of missed quest rounds that still count toward a streak.

Required range: 0 <= x <= 9007199254740991
maxTotalCompletions
integer | null

Maximum number of total quest completions.

Required range: 1 <= x <= 9007199254740991
discordShareChannelId
string | null

Discord channel in your server where the quest is shared.

Pattern: ^\d{16,20}$
discordPingRoleIds
string[] | null

Discord roles in your server to ping when a quest is activated or resets.

Maximum array length: 16
Pattern: ^\d{16,20}$