Skip to main content
GET
JavaScript

Authorizations

Authorization
string
header
required

A company API key, company scoped JWT, app API key, or user OAuth token. You must prepend your key/token with the word 'Bearer', which will look like Bearer ***************************

Headers

Api-Version-Date
string

Pins the request to a dated API version.

Example:

"2026-07-20"

Query Parameters

period
enum<string>
default:all_time

Time window for the rankings. day, month, and year count earnings since the start of the current calendar day, month, or year; last_30_days counts earnings over the trailing 30 days; all_time ranks lifetime earnings.

Available options:
day,
month,
year,
last_30_days,
all_time

Response

caller has no referral earnings

leaders
object[]
required

The top referrers by total earnings, best first.

Maximum array length: 10
me
object | null
required

The caller's own standing; null when the caller has no referral earnings.