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. Leaderboards

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


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

PreviousRetrieve a leaderboardNextReviews

Last updated 10 months ago

Was this helpful?

that describes the rewards of the sprint

TipTap document

List sprints for a community

get
Path parameters
subdomainstringRequired
Query parameters
onlyCurrentboolean | nullableOptionalDefault: false
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}/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-05-16T23:53:28.421Z",
      "startingAt": "2025-05-16T23:53:28.421Z",
      "createdAt": "2025-05-16T23:53:28.421Z",
      "v2": true,
      "name": "text",
      "description": "text",
      "image": "text",
      "color": "text",
      "includedQuestIds": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    }
  ]
}
  • Overview
  • The Leaderboard sprint object
  • API Reference
  • GETList sprints for a community