CrossHero

Returns the gym's setup status: the welcome steps (programs, timetable, plans, memberships, workouts, app) and whether each is done, the counts behind them, every program with its id, colour and booking settings, whether workouts are enabled, the rooms or sites for gyms that use them, where the gym is (country, city, time zone, currency and the language its members see), the online payment gateways it has connected and the ones its country allows, and what the owner said when a previous setup interview ended (rating, what they still needed, when to pick it up again). Call it first when asked to set the gym up or to change its configuration, and again after a step to confirm it is done.

get_gym_setup

The Customer profile report: active members by gender (female, male, other, unspecified) and by age band (under 18, 18-24, 25-34, 35-44, 45-54, 55+, unspecified), each with average attendances per member per month over the period, the share at risk today (7-31 days without booking or checking in) and, of those whose membership ended in the period (drop-in plans aside), the share with no current membership today, counted as get_non_renewals_summary counts it. The current quarter by default (period=month|quarter|year, or explicit dates). Filter by program and by plans (a gym with several sites often names the site in the plan). Aggregates only: a group of fewer than 5 people shows its size but not its figures, and the answer never says who is in a group; no figures are shared when the selection, or what separates it from the same query with fewer filters, is that small. Also reports how many members have no gender or birthdate on their profile. At most 731 days.

get_demographics

The Customers at risk report, as of today: how many active members have gone 7 to 31 days without booking or checking in, split into low (7-10 days), moderate (11-15) and high (16-31) risk, against the number of active members. Counts only; the names are on the report page linked in the answer. Excludes staff, paused memberships and Gympass-only members, as the page does.

get_retention_summary

The No-shows report: reservations marked as no-show over a period (the current quarter by default; period=month|quarter|year, or explicit dates), as a total, per program and per month. Counts only; the report page linked in the answer lists each one. Filter by program. At most 731 days.

get_no_shows_summary

The Didn't renew report: memberships whose end date falls in a period (the current month by default; period=month|quarter|year, or explicit dates) and that expired or were cancelled, per plan, with how many of those people have not renewed (no active, pending or paused membership today). Counts of people only; the names are on the report page linked in the answer. Drop-in plans are counted apart from regular plans. Filter by plan. At most 731 days.

get_non_renewals_summary

Paid membership invoices between two dates, as the Plans report shows them: amount and invoice count per plan, the total per month, and the best, worst and average month among the completed ones. Defaults to the last three months, including the current one. Excludes Gympass. At most 731 days.

get_sales_by_plan

Returns one scheduled class with its coach, program, room, reservations against capacity, waiting list, no-shows and whether booking is open. Counts only, never the athletes' names. Find it by class_id, or by date plus start time (and program_id when several programs run at that time). Missing scheduled classes are created from the recurring timetable within the booking horizon, and are published to the gym's connected booking partners (e.g. Gympass) when it has any.

get_class

Returns the workout programmed for one date, with every part (warm-up, strength, metcon...) as Markdown. Defaults to today in the gym's time zone. A gym can run several programs, each with its own session that day: pass program_id for one of them, or omit it to get every program's session for that date.

get_workout

Every score the connected user logged for one movement or benchmark, newest first, always including their PR: the score, RX/RX+/Scaled and the date. For a lift it adds the estimated one-rep max and its 95%-55% loads (as the scores page shows them), which is what to base a load recommendation on; for a benchmark, its definition. Name the movement, or pass a score_id from list_my_personal_records. 10 scores by default, at most 50.

get_my_score_history

Totals for one month, as the invoices page counts them: an invoice belongs to the month it was paid in, or, while unpaid, to the month it is dated. The total is broken down by payment method and by status (paid, unpaid...). Also what the dashboard reports as collected (paid invoices, point-of-sale and store orders) against the previous month: to date for the current month, the whole month for a finished one. Optional filters by status, payment method and payment date narrow the invoice totals only. Defaults to the current month. Never lists the members behind the invoices.

get_billing_summary

The numbers on the admin dashboard, as of today: active and inactive members, active memberships and their change against 30 days ago, billing so far this month against the previous month and today, today's reservations against capacity per program, how many memberships expire this week and the next class. Member counts come from a daily snapshot and can be a day behind.

get_dashboard_stats

Lists the scheduled classes (sessions athletes book) between two dates, in time order, with coach, program, room, reservations against capacity and waiting list size. Counts only, never the athletes' names. Defaults to today. Filter by program, and by coach with coach_id ("me" for the connected user's own classes). Users without permission to see other coaches' classes get their own. At most 31 days and 200 classes per call. Missing scheduled classes are created from the recurring timetable within the booking horizon, and are published to the gym's connected booking partners (e.g. Gympass) when it has any.

list_classes

Lists the invoices the page counts for one month — paid in it, or unpaid and dated in it — newest first, with number, date, payment date, status, payment method, plan and amount. Never the member's name or contact details: for who owes what, send the user to the invoices page linked in the answer. Same filters as the invoices page: status, payment method and payment date. Defaults to the current month; at most 100 rows.

list_invoices

Lists the gym's plans (the packages members buy: monthly unlimited, 8 sessions a month, yearly...) with price, billing period, the programs and bookings each credit allows, whether members can buy them in the app, and how many memberships are on each, plus the gym's taxes with the ids create_plan and update_plan take.

list_plans

Lists every program with its id and colour, the ids the other settings tools take. For a user who manages programs, also each program's booking settings (when booking opens and closes, the cancellation window, daily and future booking limits) and how many timetable entries, workouts and subscribed customers it has.

list_program_settings

Lists the gym's programs (e.g. CrossFit, Open Box, Kids). Every workout belongs to one program on one date. Call this once when a program id is needed; the program marked as default is the one to use when the user names none.

list_programs

Lists the recurring timetable (the weekly entries classes are generated from): program, weekdays, hours, places, coach and room, with each entry's id. This is the configuration, not the booked classes of a given day: for those use list_classes. The staff who can coach an entry and, for gyms with rooms or sites, the locations come back too, with the ids the timetable tools take.

list_recurring_classes

Lists the part types a workout can be built from (warm-up, skill, weightlifting, gymnastics, benchmark metcon, custom metcon, not scorable, plus the gym's own custom types) with the label the coach sees, and the score types (time, reps, rounds_reps, weight...) accepted by scorable parts. Use the `key` values as `type` and `score_type` when creating workouts.

list_component_types

Lists the workouts programmed between two dates, oldest first. Use it to review recent programming before suggesting what comes next, or to see which days of a week are still empty. Covers every program in the gym unless program_id names one. Defaults to the last 28 days plus the next 7; at most 120 days and 60 workouts per call.

list_workouts

The connected user's own personal records (My scores): their best score per movement or benchmark in weightlifting, gymnastics and benchmark workouts, with the date, RX/RX+/Scaled and, for lifts, the estimated one-rep max. Never anyone else's scores. Filter by category or by movement name. Use get_my_score_history for every score of one movement. At most 200.

list_my_personal_records

The connected user's own scores between two dates, newest first: every workout part they scored, in class or on their own, with the score, RX/RX+/Scaled and whether it was a PR. Never anyone else's. Defaults to the last 30 days; at most 366 days and 100 scores per call.

list_my_results

Searches the gym's movement library: weightlifting lifts, gymnastics skills and benchmark workouts (Fran, Murph...). Movements are stored by their canonical (usually English) name; the search is accent- and case-insensitive. Use the exact returned name as `movement` when creating weightlifting, gymnastics or benchmark parts so scores and PRs track correctly.

search_movements

Switches the workouts module on or off for the gym. Off suits gyms that do not program daily workouts (yoga, pilates, martial arts...): it hides workouts and scores from members and staff and removes the workout tools from this connection. Nothing is deleted; switching it back on restores everything.

update_gym_settings

Changes a plan's name, price, billing period, credits or purchase settings. Only the fields you pass change; `credits` replaces the whole list, so pass every credit you want to keep. The billing period cannot change while memberships are active on the plan. A new price applies to memberships that renew from now on, so say so when changing one; on a gym charging through Mercado Pago, the subscriptions on the plan are updated there.

update_plan

Changes a program's name, colour, booking windows or limits. Only the fields you pass change. A longer cancellation window applies to classes from now on; the schedule keeps the program's classes and workouts. On a gym with a booking partner such as Gympass connected, the change is synced to the partner.

update_program

Changes a timetable entry: hours, weekdays, places, coach, room or period. Only the fields you pass change. CrossHero applies the hours, places, coach and room to the classes already generated from the entry; the members booked on them are emailed when the start time or the room changes (pass update_reason to tell them why), not for an end time, coach or places change. Whether a booking consumes a credit applies to classes generated from then on. A weekday removed or a date range narrowed cancels those classes, and changing the program cancels every future class of the entry; members booked on a cancelled class are told, and cancelled sessions are withdrawn from a connected booking partner such as Gympass. Ask the user to confirm before calling this on an entry with bookings.

update_recurring_class

Changes an existing workout, found by `workout_id` or by date and program. Only the fields you pass change; `components` replaces the whole list of parts, so pass every part you want to keep. Workouts whose parts already have athlete scores cannot have their parts replaced.

update_workout