GET
/
gamifications
/
leaderboards
curl --request GET \
  --url https://schoolmaker.co/api/v1/gamifications/leaderboards \
  --header 'Authorization: Bearer <token>'
{
  "leaderboard": {
    "total_members": 123,
    "members": [
      {
        "rank": 123,
        "id": "<string>",
        "first_name": "<string>",
        "last_name": "<string>",
        "status": "<string>",
        "email": "<string>",
        "name": "<string>",
        "total_points": 123
      }
    ]
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
time_range
enum<string>
default:all

Time range for the leaderboard: all time, last 7 days, or last 30 days

Available options:
all,
7,
30

Response

200 - application/json
Leaderboard Data
​
leaderboard
object