Zealy API
  • Introduction
  • Authentication
  • Use cases
  • Rate limits
  • Pagination
  • FAQ
  • API Reference
    • Communities
      • Community lookup
      • Community member check
      • Community Secret Retrieval
      • Community Secret Creation
    • Users
      • User lookup
      • Add & Remove XP
      • Ban user
      • Referral code
      • Delete Zealy Connect for member
    • Leaderboards
      • Retrieve a leaderboard
      • List sprints
    • Reviews
      • Claimed quests lookup
      • Review a submission
      • Review events
    • Modules
    • Quests
      • Create quest
      • Update quest
      • List quests
    • Webhooks
Powered by GitBook
On this page

Was this helpful?

  1. API Reference
  2. Quests

List quests

PreviousUpdate questNextWebhooks

Last updated 5 months ago

Was this helpful?

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

get
Path parameters
subdomainstringRequired
Header parameters
x-api-keystringRequired
Responses
200
200
application/json
400
400
application/json
401
401
application/json
403
403
application/json
404
404
application/json
409
409
application/json
429
429
application/json
500
500
application/json
get
GET /public/communities/{subdomain}/quests HTTP/1.1
Host: api-v2.zealy.io
x-api-key: text
Accept: */*
[
  {
    "description": {
      "type": "text",
      "text": "text",
      "attrs": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "marks": [
        {
          "type": "text",
          "attrs": {
            "href": "text",
            "target": "_blank",
            "class": "text",
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      ],
      "content": null,
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "id": "text",
    "name": "text",
    "deleted": true,
    "communityId": "text",
    "categoryId": "text",
    "createdAt": "2025-05-17T00:36:49.605Z",
    "updatedAt": "2025-05-17T00:36:49.605Z",
    "archived": true,
    "autoValidate": true,
    "conditionOperator": "AND",
    "conditions": [
      {
        "type": "level",
        "value": "text",
        "operator": "="
      }
    ],
    "published": true,
    "recurrence": "daily",
    "retryAfter": 1,
    "rewards": [
      {
        "type": "xp",
        "operator": "=",
        "value": "text",
        "chain": "polygon",
        "collection": "text",
        "contractAddress": "text"
      }
    ],
    "tasks": [
      {
        "id": "text",
        "metadata": null,
        "type": "api",
        "settings": {
          "title": "text",
          "description": "text",
          "endpoint": "https://example.com",
          "apiKey": "text",
          "identifications": [
            "email"
          ],
          "network": "eth-mainnet",
          "redirectUrl": "text"
        }
      }
    ],
    "claimLimit": 1,
    "claimCounter": 1
  }
]
  • Overview
  • GETList quests in a community