Skip to main content
GET
Memberships report for a period

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>
required

First day of the period (YYYY-MM-DD), on the organization's own clock.

to
string<date>
required

Last day of the period, inclusive.

clubId
integer

Only the memberships sold for this club.

compare
enum<string>
default:previous_period

What to compare the period with.

Available options:
previous_period,
previous_year,
none
granularity
enum<string>

How trend buckets the period. Chosen from the period's length when omitted.

Available options:
day,
week,
month
topPlans
integer
default:10

How many plans byPlan lists.

Required range: 1 <= x <= 50

Response

The report

period
object
timezone
string

The clock the days are read on: the organization's timezone, as on the admin analytics dashboards.

totals
object
byKind
object[]

Memberships (recurring), Passes and Drop-Ins apart.

byPlan
object[]

The plans that moved most - added plus cancelled - largest first.

comparison
object | null
trend
object