Skip to main content
GET
Who is ready for their next rank

Authorizations

Authorization
string
header
required

Organization-scoped bearer credential: a customer API key (1club_sk_live_...) or an MCP OAuth access token.

Query Parameters

from
string<date>

First day of the period whose promotions the summary counts.

to
string<date>

Last day of that period, inclusive.

clubId
integer

Only the people of this club.

status
string

Only the members with these statuses, comma-separated (eligible, on_track, stalled, no_requirement). None lists them all.

Example:

"eligible"

ageBands
string

Only the members in these age bands, comma-separated.

limit
integer
default:100

How many rows a page holds.

Required range: 1 <= x <= 500
offset
integer
default:0

How many rows to skip.

Required range: x >= 0

Response

The report, with a page of its people

asOf
string<date>
contactsWithBirthDate
integer

How many listed members have a date of birth, which the age bands read.

tracks
object[]
rowsScope
enum<string>

The scope the rows need: without it rows and total are null and the figures come alone.

Available options:
contacts:read
total
integer | null

Every row, across all pages; null when the rows are withheld.

limit
integer
offset
integer
rows
object[] | null

A member on each track they hold a rank on.