Skip to main content
The bookings module provides tools to list, create, and manage bookings for classes, sessions, or personal training slots, and track client adherence.

Available Tools

list_bookings

List client bookings for sessions or classes.
  • Type: Read-only
  • Important Input Fields:
    • clientId (string, optional): Filter bookings for a specific client.
    • coachId (string, optional): Filter bookings of events assigned to a coach (see list_staff in calendar_events).
    • locationId (string, optional): Filter bookings at a specific location (see list_locations in calendar_events).
    • dateFrom (string, optional): Start date range filter.
    • dateTo (string, optional): End date range filter.
    • attendanceStatus (string, optional): Attended, DidNotAttend or NoStatus.
Each booking includes attendanceStatus. Use it to see whether a member actually attended; bookingStatus: Completed only means the session time has passed.

get_booking

Retrieve details of a single booking.
  • Type: Read-only
  • Important Input Fields:
    • bookingId (string, required): Unique identifier for the booking.
To check whether a booking still needs payment and why it is waiting, use list_booking_payment_attention.

summarize_bookings

Retrieve booking statistics (such as cancellation rates and total bookings) within a date range.
  • Type: Read-only
  • Important Input Fields:
    • dateFrom (string, required): Start date range.
    • dateTo (string, required): End date range.

summarize_client_adherence

Evaluate check-in and attendance metrics (e.g. check-in ratios) for a specific client.
  • Type: Read-only
  • Important Input Fields:
    • clientId (string, required): Unique identifier for the client.

create_booking Write

Book a client onto a specific calendar event.
  • Type: Write
  • Important Input Fields:
    • clientId (string, required): The unique client ID.
    • calendarEventId (string, required): The unique calendar event ID.
    • paymentMethod (string, optional): product, free, or billLater. Defaults to product. Use billLater for later invoicing at the configured session price without deducting credits now.
    • creditsToDeduct (integer, optional): Custom credits to deduct when paymentMethod is product.

update_attendance Write

Record check-in, mark absent, or cancel a booking.
  • Type: Write
  • Important Input Fields:
    • bookingId (string, required): Unique identifier for the booking.
    • status (string, required): Target attendance status (e.g., attended, absent, cancelled).

Correct existing payments

Use list_booking_credit_products with clientId and bookingId to read the dashboard credit options in pages. The response includes both the credit allocation ID and its linked product ID. Pass the allocation’s creditId as clientCreditId to apply_booking_credit_product for a free booking, with the number of credits to deduct. Use update_booking_payment_method to change the method on an eligible booking. For a pending managed deduction, use change_booking_credit_source with the eligible clientProductId, then retry_booking_credits when the deduction is due. The existing chronological rules still apply. Each write requires userConfirmed: true and an idempotency key.

cancel_booking Write

Cancel one member booking as the coach, with the same cancellation policy, credit refunds, waitlist promotion and notifications as the dashboard. financialAction followPolicy (default) applies the company cancellation policy; refund returns credits or payment, retain keeps them, charge charges the member. Some companies require a cancellation reason. For a recurring booking pass the occurrence date in instanceDate. notifyClient defaults to false. Show the coach the booking, financial effect and notification choice, and get explicit confirmation first.
  • Type: Write (requires userConfirmed: true and the write-tool grant)
  • Input Fields:
    • clientId (string, required)
    • bookingId (string, required)
    • instanceDate (string, optional)
    • financialAction (string: followPolicy, refund, retain, charge, optional)
    • cancellationReasonCode (string, optional)
    • cancellationReasonText (string, optional)
    • coachNote (string, optional)
    • notifyClient (boolean, optional)
    • idempotencyKey (string, optional)

Natural Language Examples

  • “Book Sarah Jenkins into the Spin Class tomorrow evening.”
  • “Update booking book_123 to show the client attended.”

JSON-RPC Call Example (create_booking)