ZenotiHelp

Use class APIs

ZTZenoti Docs Team Updated March 7, 2026 2 min readGuide

The class APIs let you manage class schedules, guest registrations, check-ins, bookings, and class metrics. These APIs cover four functional areas: registration, operations, consumer-facing actions, and reporting metrics.

For complete endpoint documentation including request/response schemas and code examples, see the individual API reference articles linked below.


On this page


Before you begin

  • You need a valid API key or access token. See Set up API authentication.
  • Classes and workshops must be configured in your Zenoti organization.

Permission: Manage API Keys (under Administrator) -- Required to access Zenoti APIs.

Class registration

Register a guest for a class

POST /v1/classes/{class_id}/registrations

Registers a guest for a class or workshop.

Cancel a guest's registration

PUT /v1/classes/{class_id}/registrations/{registration_id}/cancel

Cancels a guest's registration for a class.

Parameter Type Required Description
class_id string Yes Class identifier
registration_id string Yes Registration identifier

Error codes: 1035 (invoice must be reopened before cancellation), 1004 (invalid registration or class-registration mismatch), 1001 (class not found).

Check in registered guests

PUT /v1/classes/{class_id}/registrations/check_in

Checks in registered guests when they arrive for the class.

Retrieve user registrations

GET /v1/classes/{class_id}/registrations

Retrieves all guest registrations for a class or workshop.

Class operations

Create a class schedule

POST /v1/classes/schedules

Creates a new class schedule.

Update a class schedule

PUT /v1/classes/schedules/{schedule_id}

Modifies an existing class schedule.

Delete a class schedule

DELETE /v1/classes/schedules/{schedule_id}

Removes a class schedule.

List class schedules

GET /v1/classes/schedules

Retrieves class schedules with filtering options.

Consumer class actions

List available classes

GET /v1/classes/available

Retrieves available classes for guests to browse and book. Used for consumer-facing booking interfaces.

Book a class

POST /v1/classes/bookings

Creates a class booking for a guest.

Cancel a class booking

PUT /v1/classes/bookings/{booking_id}/cancel

Cancels a guest's class booking.

Class metrics

Class attendance report

GET /v1/classes/metrics/attendance

Retrieves class attendance data for reporting.

Class revenue report

GET /v1/classes/metrics/revenue

Retrieves class revenue data for reporting.

Tips

  • Class registration and class booking serve different purposes. Registrations are administrative enrollments, while bookings are guest-initiated actions through consumer-facing interfaces.
  • Use webhook events (Schedule.Created, Booking.Created, Booking.Cancelled) to keep external systems synchronized with class changes.
  • Class milestones can be managed through the organization APIs. See Use organization APIs.

API reference

Was this article helpful?
Your feedback helps us improve our documentation.