List sprints

Overview

This endpoint allows you to retrieve the list of sprints that happened in your community. If you pass the onlyCurrent=true query params to the query, it will only return the active sprint.

The Leaderboard sprint object

---

id - String

ID of the sprint

---

name - String

Name of the sprint

---

description - String

Description of the sprint

---

image - String

Url of the sprint image

---

color - String

Hex color associated with the sprint (e.g: "#833f6a")

---

rewards - Object

TipTap document that describes the rewards of the sprint

---

rewardZone - Number

Leaderboard position until which the users will be rewarded.

---

includedQuestsIds - Array of strings

IDs of the quests that are part of the sprint.

Currently, if the array is empty, it means that all quests in the community are part of the sprint. This behavior will be deprecated soon.

---

startingAt - String

ISO timestamp that indicates the start of the sprint

---

endingAt - String

ISO timestamp that indicates the end of the sprint

---

createdAt - String

ISO timestamp that indicates the creation date and time of the sprint

---

API Reference

List sprints for a community

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

Path parameters

subdomain*string

Query parameters

Header parameters

Response

200400401403404409429500

200

Body

application/json

data*array of object

Request

JavaScriptCurlPython

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

Response

200400401403404409429500

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "rewards": {
        "type": "text",
        "text": "text",
        "attrs": {},
        "marks": [
          {
            "type": "text",
            "attrs": {
              "href": "text",
              "target": "_blank",
              "class": "text"
            }
          }
        ]
      },
      "rewardZone": 0,
      "endingAt": "2024-11-21T06:26:44.013Z",
      "startingAt": "2024-11-21T06:26:44.013Z",
      "createdAt": "2024-11-21T06:26:44.013Z",
      "v2": false,
      "name": "text",
      "description": "text",
      "image": "text",
      "color": "text",
      "includedQuestIds": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    }
  ]
}