Club Planner

Lists invoices and other financial documents (credit notes, quotes, pro formas) dated in a period, newest first, with customer, amount, VAT, open amount and status. Drafts (documents still in the club's initial status, not yet final) are left out unless includeDrafts is true; every row says whether it is a draft. Can show only documents that still have an open amount. The status is the club's own status name, in the club's language. Amounts in EUR. Defaults to the last 30 days; a period covers at most 366 days.

list_invoices

Lists leads (prospects) with their status in the sales follow-up (created, planned, interrupted, finished), source, contact details and remarks, newest first. Can search on name, e-mail or phone, and filter on status and creation date.

list_leads

Lists check-ins in a period, newest first, optionally for one member. Every attempt is logged, also a refused one (no valid membership, blocked, ...): accepted says whether the member was let in, resultCode is a fixed English code (e.g. success, noSubscription, blocked) and result the text the club's screen showed, in the club's language. Set acceptedOnly to list visits only. One code depends on the club's settings: hasRemainderLeft (open balance) blocks the gate beyond the club's limit but may let the member in below it; it is reported as not accepted. Defaults to the last 30 days; a period covers at most 366 days.

list_member_visits

Lists the members most likely to cancel, highest retention score first. The retention score (0-100) is rule based: days since the last visit, visit decline against the member's own average, onboarding in the first 90 days, failed payments, booking behaviour, contract end, freeze or downgrade, coach departure and app engagement. Each member comes with the top reason, the last visit, the contract end and the retention journey the member is in. Only works for clubs that have the retention score switched on (Settings > Members > Retention).

list_at_risk_members

Lists the active membership types the club sells, with price, duration, kind (membership or punch card) and group, a page at a time. A type without a club restriction is sold in every club (soldInAllClubs: true), so with clubId it appears for each club, exactly as in Club Planner.

list_subscription_types

Lists reservations for one member, for one class, or for one calendar in a period (give exactly one of memberId, classId or calendarId). For a calendar the period defaults to today and the next 6 days, at most 62 days.

list_reservations

Lists who works when: the staff schedule entries in a period, per employee. type is shift (working), break (a pause within a shift) or note (a note on the schedule). Absences such as holidays are not part of this schedule. Defaults to today and the next 6 days; a period covers at most 62 days.

list_staff_schedule

Lists who is on the waiting list of one class, in order of signing up.

list_waiting_list

The retention dashboard in one call: members per retention status (low, medium, high risk, sleeping), members at risk and the change against 30 days ago, new members whose onboarding is at risk, members saved by a retention journey in the last 30 days, the weekly risk distribution and the most common reasons.

get_retention_summary

Finds members by name, e-mail address, phone number or member card number, and can narrow the list to a member status or to members whose last visit is longer ago than a number of days. Returns a page of members with contact details, status, last visit (the last day the member was let in; null when never) and visits (the number of days with an accepted check-in).

search_members