---
title: "Get leaderboard"
method: POST
path: "/public/get-school-leaderboard"
tags: ["Gamification"]
---

# Get leaderboard

`POST /public/get-school-leaderboard`

Get leaderboard of the top ranking users in your school

Rate limit: Maximum 60 requests in a window of 1m.

## Request body

- object
  - `data` object[], required
    - `data` object, required
      - `data` object, required
        - `fermionSchoolId` string, required — Your school ID
        - `period` 'Today' | 'ThisWeek' | 'ThisMonth' | 'AllTime', required — The period for which you want to request leaderboard
        - `limit` integer, required — The number of top users to include in the leaderboard

## Response `200`

API Response Body

- object[]
  - `output` union, required
    - object
      - `status` 'ok', required
      - `data` object, required
        - `leaderboardUsers` object[], required
          - `rank` integer, required — Rank or position of user in the leaderboard
          - `xpTotal` integer, required — Total XP of the user
          - `xpDeltaInPeriod` integer, required — XP the user gained or lost in the given period
          - `fermionUserId` string, required — Internal fermion user ID of the user
          - `saasUserId` union, required — The user ID of the user in your DB
            - string
            - unknown
            - unknown
          - `userCreatedAtIso` string, date-time, required — The date when the user joined in ISO format
          - `name` string, required — Name of the user
          - `username` string, required — Username of the user
          - `profilePicUrl` string, uri, required — Profile Photo URL of the user
    - object
      - `status` 'error', required
      - `errorMessage` string, required

---

[API](https://skmtc.net/fermion/apis/fermion-backend-api.md) · [All operations](https://skmtc.net/fermion/apis/fermion-backend-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/fermion/fermion-backend-api/revisions/7ce364c8820b/schema)