About the Bookings Attendance API

With the Bookings Attendance API, you can retrieve and manage a booking session's attendance information, including whether the session was attended and how many participants attended.

  • Set attendance for a booking session.
  • Retrieve attendance information.

The number of attendance objects for a booking depends on the service type:

  • Appointments have a single attendance object per booking.
  • Classes and courses have an attendance object for each session related to the booking.

Before you begin

It's important to note the following points before starting to code:

  • Validation capabilities in Set Attendance are limited. For example, ensure that you validate numberOfAttendees relative to both attendance.status and the booking's numberOfParticipants in your code.

Use cases

  • Set the attendance when a customer checks in for their booking.
  • Determine which participants have missed the majority of a course's sessions.

Terminology

For a comprehensive glossary of Bookings terms, see Terminology (SDK | REST).

Did this help?