Skip to main content
GET
Get the leaderboard
See the leaderboards guide for period windows, what rank means under a department filter, and refresh cadence.

Authorizations

Authorization
string
header
required

API key — tb_live_… for production data, tb_test_… for the sandbox.

Query Parameters

cursor
string

The pagination.next_cursor of the previous page. Omit it, or send it empty, for the first page. A cursor is opaque and works only on the endpoint that returned it, for the same company.

Maximum string length: 512
Example:

"djEuQ2hhY2hhMjAuZXhhbXBsZS1jdXJzb3I"

limit
integer
default:25

How many items to return per page, from 1 to 100.

Required range: 1 <= x <= 100
Example:

25

period
enum<string>
default:all_time

The window XP is counted over. Months are calendar months in UTC.

  • all_time: all XP ever earned.
  • this_month: XP earned since the 1st of the current month.
  • last_3_months: XP earned in the current month and the two before it.
  • last_year: XP earned in the current month and the eleven before it.
Available options:
all_time,
this_month,
last_3_months,
last_year
Example:

"this_month"

department_id
string<uuid>

Only members of this department (not of its sub-departments). Each keeps their company-wide rank, so ranks on a filtered page can have gaps.

Example:

"b3e1f7a2-6c4d-4e8f-9a1b-2c3d4e5f6a7b"

Response

A page of the leaderboard.

data
object[]
required

Employees on this page, highest rank first.

pagination
object
required

Where the next page starts.