List quests

Overview

This endpoint retrieves all quests and their details for a specified community. Admin role required.

The claimCounter indicates the number of claims made for a quest. Note: this value is not real-time; it is cached for 1 hour.

List quests in a community

GEThttps://api-v2.zealy.io/public/communities/{subdomain}/quests

Path parameters

subdomain*string

Header parameters

Response

200400401403404409429500

200

Body

application/json

description*nullable object

id*string

name*string

deletedboolean

communityIdstring

categoryIdstring

createdAtstring (date-time)

updatedAtstring (date-time)

archived*nullable boolean

autoValidateboolean

conditionOperator*nullable enum

ANDOR

conditions*array of object

published*boolean

recurrence*enum

dailyweeklymonthlyonce

retryAfter*nullable number

rewards*nullable array of object

tasks*array of all of

claimLimitnullable number

claimCounternullable number

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://api-v2.zealy.io/public/communities/{subdomain}/quests', {
    method: 'GET',
    headers: {
      "x-api-key": "text"
    },
});
const data = await response.json();

Response

200400401403404409429500

[
  {
    "description": {
      "type": "text",
      "text": "text",
      "attrs": {},
      "marks": [
        {
          "type": "text",
          "attrs": {
            "href": "text",
            "target": "_blank",
            "class": "text"
          }
        }
      ]
    },
    "id": "text",
    "name": "text",
    "deleted": false,
    "communityId": "text",
    "categoryId": "text",
    "createdAt": "2025-01-22T04:42:46.099Z",
    "updatedAt": "2025-01-22T04:42:46.099Z",
    "archived": false,
    "autoValidate": false,
    "conditionOperator": "AND",
    "conditions": [
      {
        "type": "level",
        "value": "text",
        "operator": "="
      }
    ],
    "published": false,
    "recurrence": "daily",
    "retryAfter": 0,
    "rewards": [
      {
        "type": "xp",
        "operator": "=",
        "value": "text",
        "chain": "polygon",
        "collection": "text",
        "contractAddress": "text"
      }
    ],
    "tasks": [
      {
        "id": "text",
        "type": "api",
        "settings": {
          "title": "text",
          "description": "text",
          "endpoint": "https://example.com",
          "apiKey": "text",
          "identifications": [
            "email"
          ],
          "network": "eth-mainnet",
          "redirectUrl": "text"
        }
      }
    ],
    "claimLimit": 0,
    "claimCounter": 0
  }
]