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.


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

get
Path parameters
subdomainstringRequired
Query parameters
onlyCurrentboolean | nullableOptionalDefault: false
Header parameters
x-api-keystringRequired
Responses
200
200
application/json
get
GET /public/communities/{subdomain}/leaderboard/sprint HTTP/1.1
Host: api-v2.zealy.io
x-api-key: text
Accept: */*
{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "rewards": {
        "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"
      },
      "rewardZone": 1,
      "endingAt": "2025-06-27T09:42:08.582Z",
      "startingAt": "2025-06-27T09:42:08.582Z",
      "createdAt": "2025-06-27T09:42:08.582Z",
      "v2": true,
      "name": "text",
      "description": "text",
      "image": "text",
      "color": "text",
      "includedQuestIds": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    }
  ]
}

Last updated

Was this helpful?