Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Public API access token issued by /public/v1/oauth/token. Example: Authorization: Bearer fspt_.... Each resource request rechecks the token company's current provider access. Disabling access blocks existing tokens with 403 auth.provider_unavailable.

Path Parameters

clientId
string
required

Client in the company bound to the Public API token.

Pattern: ^[a-fA-F0-9]{24}$

Query Parameters

clientId
string

Identifies a client in the company bound to the Public API token.

Example:

"67f1234567890abcdef1234"

page
integer
default:1
Required range: x >= 1
Example:

1

limit
integer
default:10

Page size. Defaults to 10.

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

10

weekStart
string<date>

Show a past week instead of the current one: any date inside that week (YYYY-MM-DD), normalised to its Sunday 00:00 UTC start. Omit for the current week (unchanged behaviour). The leaderboard_position notification's action.data.weekStart can be passed as-is. A date in a future week returns 400 LEADERBOARD_WEEK_START_INVALID.

Example:

"2026-10-04"

gender
enum<string>

Show only members of this gender. prefer_not_to_say includes members without a stated gender and members who chose 'Other'. Omit, leave empty or pass all for everyone. The response shape is unchanged: ranks, podium, data, currentUser, totalCount and pagination are all computed within the filtered board, and currentUser is empty when the client is outside the filter. Any other value returns 400 LEADERBOARD_FILTER_INVALID.

Available options:
male,
female,
prefer_not_to_say,
all
Example:

"female"

scoringType
enum<string>

Rank by the XP earned only from WODs with this scoring type in the week, so xp, ranks and the podium reflect those WODs alone. A WOD set to standard uses the scoring type of its planned workout. Members without XP from matching WODs are not listed. Omit or pass all for total weekly XP. Combines with gender and allowedDivisions. Any other value returns 400 LEADERBOARD_FILTER_INVALID.

Available options:
standard,
forTime,
amrap,
emom,
tabata,
maxLoad,
all
Example:

"maxLoad"

allowedDivisions
enum<string>

Rank by the XP earned only from WODs whose allowed divisions are exactly this set: rx (RX only), scaled (Scaled only) or rx_scaled (both). It filters on the WOD setting, not on the division a member chose. Omit or pass all for total weekly XP. Combines with gender and scoringType. Any other value returns 400 LEADERBOARD_FILTER_INVALID.

Available options:
rx,
scaled,
rx_scaled,
all
Example:

"rx_scaled"

Response

Paginated weekly ranking with static current-user row.

data
object
required
meta
object
required