Skip to main content
GET
/
v1
/
community
/
quests
/
{questId}
cURL
curl --request GET \
  --url https://api.flipsuite.xyz/v1/community/quests/{questId} \
  --header 'x-api-key: <x-api-key>'
{
  "id": "097d191c-644c-433b-8d8a-a6a1bda7f9df",
  "communityId": "90895e48-0db7-4e99-b63a-b4401753da62",
  "name": "Raffle Quest",
  "shortDescription": "Quest intro",
  "fullDescription": "Extra quest description and instructions",
  "createdAt": 1776683462270,
  "startTime": 1776683462270,
  "endTime": 1776942662270,
  "status": "ACTIVE",
  "recurrence": "ONCE",
  "recurrenceInterval": 259200000,
  "visibility": "PUBLIC",
  "iteration": 1,
  "iterationCompletions": [
    23
  ],
  "totalCompletionCount": 23,
  "tasks": [
    {
      "id": "9f3b1b72-c824-4da3-b091-c602bdb2e54b",
      "type": "TWITTER_POST_INTERACTION",
      "postUrl": "https://x.com/flipsuitexyz/status/2021683679102206339",
      "isLikeRequired": true,
      "isRepostRequired": true,
      "isCommentRequired": true
    }
  ],
  "rewards": [
    {
      "id": "6476d69e-b628-4b12-bc5f-7ed48e09a741",
      "type": "FIXED",
      "strategy": {
        "type": "RAFFLE",
        "maxWinners": 5
      },
      "item": {
        "type": "TOKEN",
        "chain": "Base",
        "tokenAddress": "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913",
        "amount": 1
      }
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.flipsuite.xyz/llms.txt

Use this file to discover all available pages before exploring further.

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
​
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
​
maxTotalCompletions
integer | null

Maximum number of total quest completions.

Required range: 1 <= x <= 9007199254740991