Claimed quests lookup

Overview

Those two endpoints allow you to retrieve claimed quests.

The Review object

---

id - String

ID of the claimed quest

---

user - Object

Object containing the id, name, and avatar url of the user

---

quest - Object

Object containing id and name of the quest

---

status - Enum (success, fail, pending)

Status of the review

---

mark - Enum (star, flag)

This field defines if the review has been marked as a star or if the review has been flagged. It can be null if none of the actions have been performed.

---

tasks - Array of object

Contains the list of tasks the user completed, with the submissions if any. To know more about tasks, check our product docs.

---

updatedAt - String

ISO timestamp that indicates the last date at which the claimed quest was updated

---

createdAt - String

ISO timestamp that indicates the date at which the quest was claimed

---

The Task object

Common properties

The following properties are set in all task types

---

type - String

ID of the task

---

type - Enum

The possible values are: api, text, discord, url, telegram, quiz, invites, visitLink, file, date, number, poll, opinion, twitterFollow, twitterSpace, tweetReact, tweet, tiktok.

---

Status - Enum (error, success, in-review)

Status of the task

---

createdAt - String

ISO timestamp that indicates the date at which the task was completed

---

Exclusive properties

The following properties are only set in one or multiples task types.

---

value - String or Number

Value submitted by the user when completing the task. This property is set for the following task types: tiktok, opinion, number, date, url, text.

---

values - Array of String

Values submitted by the user when completing the task. Can hold one or multiple values. This property is set for the following task types: quiz, poll.

---

fileUrls - Array of String

This properties contains the URLs of the files a user submitted. This property is set for the task type file.

---

tweetId - String

This property contains the ID of the tweet the user submitted. This property is set for the task type tweet.

---

API Reference

Get a review

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

Path parameters

id*string (uuid)

subdomain*string

Header parameters

Response

200400401403404409429500

200

Body

application/json

id*string (uuid)

user*object

quest*object

status*enum

pendingsuccessfail

mark*nullable enum

starflag

lastReviewerId*nullable string (uuid)

createdAt*string

updatedAt*string

tasks*array of all of

autoValidated*boolean

Request

JavaScriptCurlPython

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

Response

200400401403404409429500

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "user": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "avatar": "text"
  },
  "quest": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text"
  },
  "status": "pending",
  "mark": "star",
  "lastReviewerId": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "text",
  "updatedAt": "text",
  "tasks": [
    {
      "id": "text",
      "createdAt": "2024-11-21T06:46:59.999Z",
      "status": "error",
      "type": "onChain"
    }
  ],
  "autoValidated": false
}

List reviews for a community

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

Path parameters

subdomain*string

Query parameters

Header parameters

Response

200400401403404409429500

200

Body

application/json

items*array of object

nextCursor*nullable string

Request

JavaScriptCurlPython

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

Response

200400401403404409429500

{
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "user": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "avatar": "text"
      },
      "quest": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text"
      },
      "status": "pending",
      "mark": "star",
      "lastReviewerId": "123e4567-e89b-12d3-a456-426614174000",
      "createdAt": "text",
      "updatedAt": "text",
      "tasks": [
        {
          "id": "text",
          "createdAt": "2024-11-21T06:46:59.999Z",
          "status": "error",
          "type": "onChain"
        }
      ],
      "autoValidated": false
    }
  ],
  "nextCursor": "text"
}