classes:read. Class management requires classes:write. Reading a class roster and booking a customer into a class use the bookings scopes.
List classes
recurrenceId and occurrenceIndex. A row’s id is what a booking’s classId points at. The endpoint returns class schedule, price, capacity, gym, area, instructors, and status fields, ordered by start time.
Query parameters, all optional:
startDate,endDate- ISO date-times, or a bareYYYY-MM-DDread as midnight UTC.startDatekeeps occurrences still running at or after it, andendDatekeeps occurrences starting before it. With neither, the whole schedule is in scope, past included.clubId,classTypeId,instructorId- narrow to one gym, class type, or instructorstatus-activeorcancelledsport- only classes for this sportsearch- case-insensitive match on the class namelocale- resolvenameanddescriptionin this locale, for exampleenlimit- 1 to 100, defaults to 50offset- defaults to 0
Get a class
Create a class
Send one class occurrence, or addrecurrence to create a whole repeating series in one request.
Z or an explicit UTC offset. clubId, name, startTime, and endTime are required. The other fields are areaId, classTypeId, instructorIds (up to 20), description, scheduleNote, priceBeforeTax, isFree, maxCapacity, visibility, sport, and color (a hex value such as #1E88E5). Unknown fields are rejected with a 400.
All referenced gyms, areas, class types, and instructors must belong to the authorized organization. An area must belong to the selected gym.
Recurring classes
Addrecurrence to create a series. startTime and endTime are still required: they are the template slot that gives every occurrence its time of day and duration, and the series starts from startTime.
frequency-daily,weekly, ormonthlyinterval- every N days, weeks, or months, 1 to 365. Defaults to 1.daysOfWeek- for a weekly series, the days it runs onends.type-until(runs toendDate),after(runs forends.occurrencessessions), orneverends.occurrencescounts occurrences, not weeks, across every day indaysOfWeek. Twelve weeks of a Monday and Wednesday class is24.
RECURRENCE_TOO_MANY_OCCURRENCES. An open-ended series creates a rolling window and extends itself. The response is the first occurrence, with series.occurrencesCreated. An occurrence at a gym that is closed is skipped rather than failing the request, so compare that count with what you expected.
The area is checked for a clash on the first occurrence only, the same rule
the dashboard applies. Read the area’s availability for the window first if later
weeks matter.
Update a class
Send only fields that should change:409 Conflict. Add notifyCustomer: true to tell booked customers about the change.
For a recurring class, add ?scope=all_future to apply the edit to this and every later occurrence. The default is this_instance. With scope=all_future, a body carrying only recurrence.ends and recurrence.endDate moves where the series ends. A later end creates the new occurrences, and an earlier one removes the occurrences past it, refused with 409 when any of those has an active booking or waitlist entry. The cadence (frequency, interval, daysOfWeek) cannot be changed: delete the remaining series and create it again.
Delete a class
Delete one occurrence:?scope=all_future to delete this and later occurrences. The default is this_instance.
Deletion returns 409 Conflict when affected future classes have active customer bookings or waitlist entries. Cancel or move those records before retrying.
Class roster
Requires thebookings:read scope. Returns who is booked into one class occurrence, whether they were checked in, and what they paid.
status (optional, for example confirmed, checked_in, or cancelled), limit (1 to 100, defaults to 100), and offset.
Each attendee row carries bookingId, classId, contactId, contactName, bookerName, contactEmail, status, source, startTime, endTime, checkedIn, checkedInAt, membershipId, entranceMethod, payment, notes, and createdAt. contactEmail is null unless your key also holds contacts:read. An anonymous seat has a null contactId, and bookerName is who paid for it.
Cancelled seats are left out unless you ask for status=cancelled. Do not expect total to equal the class’s booked count: the roster keeps no-shows, and the booked count adds walk-in check-ins that have no booking.
Book a customer into a class
Requires thebookings:write scope. Enrols one customer in a class occurrence, the way the gym’s staff add someone to a class. Booking into classes is limited to 60 requests per minute, in addition to the standard limit.
contactIdorcustomer- exactly one, as on Create a bookingpayment.status(required) -paidorunpaidpayment.amount,payment.reference,payment.fee(optional) - as on Create a booking.amountdefaults to the class price.notes(optional) - up to 2,000 charactersnotifyCustomer(optional) - defaults tofalsefor an API key
unpaid and no amount, a membership the customer holds that covers the class is used, so one session is spent and nothing is owed; otherwise the class price is recorded as owed.
Returns 201 with the same booking object as Create a booking, with classId set. A cancelled class (CLASS_CANCELLED) or one that has already run (BOOKING_ALREADY_ENDED) is a 400. A full class, or a customer already booked on it, teaching it, or checked in to it, is a 409.
Class types and progression tracks
A class type is a kind of class the gym runs. Set a class’sclassTypeId to file it.
GET /v1/platform/class-typesandGET /v1/platform/class-types/{id}- list and read class types. The list returns{ "data": [...] }with no paging. Requiresclasses:read.POST /v1/platform/class-typesandPATCH /v1/platform/class-types/{id}- create and update a class type. Every field applies to classes already scheduled as this type, not only new ones. Requiresclasses:write.GET /v1/platform/progression-tracks- the rank ladders the gym uses, to link a class type to one withprogressionTrackId. Requiresclasses:read.