Skip to main content
GET
Which memberships end soon

Authorizations

Authorization
string
header
required

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

Query Parameters

days
enum<integer>
default:30

How many days ahead, from today on the organization's clock.

Available options:
7,
14,
30,
60
clubId
integer

Only the people of this club.

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

from
string<date>

Today, on the organization's clock.

to
string<date>

The window's last day.

days
enum<integer>
Available options:
7,
14,
30,
60
totals
object

Per group: how many, and what they are worth a month, ex-tax.

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