Skip to main content
GET
/
v1
/
community
/
quests
cURL
curl --request GET \
  --url https://api.flipsuite.xyz/v1/community/quests \
  --header 'x-api-key: <x-api-key>'
{
  "data": [
    {
      "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
          }
        }
      ]
    }
  ],
  "pagination": {
    "offset": 123,
    "limit": 123,
    "total": 123,
    "count": 123
  }
}

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
required

Your community API key

Query Parameters

​
statuses
enum<string>[]

Quest statuses to filter by

Available options:
DRAFT,
TEMPLATE,
ACTIVE,
PAUSED,
REVIEW,
ENDED,
ARCHIVED
​
recurrenceTypes
enum<string>[]

Quest recurrence types to filter by

Available options:
ONCE,
DAILY,
WEEKLY,
MONTHLY,
CUSTOM
​
visibilityTypes
enum<string>[]

Quest visibility types to filter by

Available options:
PRIVATE,
PUBLIC,
SHARED
​
taskTypes
enum<string>[]

Task types to filter by

Available options:
API,
DISCORD_ACCOUNT_AGE,
DISCORD_SERVER_ROLES,
DISCORD_USERS,
FILE_UPLOAD,
NFT_BALANCE,
NUMBER_INPUT,
POINTS_BALANCE,
POINTS_TIP,
POLL_INPUT,
TEXT_INPUT,
TOKEN_BALANCE,
TOKEN_SWAP,
TOKEN_TIP,
TWITTER_ACCOUNT_AGE,
TWITTER_ACCOUNT_FOLLOW,
TWITTER_ACCOUNT_FOLLOWERS,
TWITTER_ACCOUNT_SUBSCRIBE,
TWITTER_ACCOUNT_VERIFIED,
TWITTER_POST_CREATE,
TWITTER_POST_INTERACTION,
WALLET_INPUT
​
rewardTypes
enum<string>[]

Reward types to filter by

Available options:
FIXED,
SHARED,
RANDOM
​
query
string

Search query to match quest name and description against

Maximum string length: 256
​
offset
number
default:0
Required range: x >= 0
​
limit
number
default:20
Required range: 0 <= x <= 50

Response

200 - application/json

Quests have been retrieved

​
data
object[]
required

Quests matching the query

​
pagination
object
required

Pagination metadata