Retrieve the schedules of classes in multiple centers

get https://api.zenoti.com/v1/classes/sessions?center_id={center_id}&page={page}&class_name={class_name}&start_date={start_date}&end_date={end_date}&show_in_catalog={show_in_catalog}&status={status}&registration_id={registration_id}&session_id={session_id}&filters[0].property={filters[0].property}&filters[0].value={filters[0].value}&filters[1].property={filters[1].property}&filters[1].value={filters[1].value}{&filters[2].property=}filters[2].property{&filters[2].value=}filters[2].value{&filters[3].property=}filters[3].property{&filters[3].value=}filters[3].value{&filters[4].property=}filters[4].property{&filters[4].value=}filters[4].value{&class_id=}class_id{&recurrence_id=}recurrence_id{&session_name=}session_name{&guest_id=}guest_id{&size=}size{}

This API helps you to retrieve the list of active schedules of classes sessions in multiple centers.

You must provide the appropriate details in the API request for the center_id parameters. Optionally, you can also specify the required details in the API request for several other parameters to filter the search results in the API response. Refer to the Request Parameters table for more information.

Response Details

Name	Type	Description
sessions	object	Object that contains detailed information on the class sessions that have been booked in the centers during the specified time period. For more information, refer to the sessions Object table.
classes	object	Object that contains detailed information on the classes that are available in the centers. For more information, refer to the classes Object table.
instructors	object	Object that contains detailed information on the class instructors that work in the centers. For more information, refer to the instructors Object table.
categories	object	Object that contains detailed information on the categories of classes in the centers. For more information, refer to the categories Object table.
rooms	object	Object that contains detailed information on the rooms of the specified centers in which the class sessions will be performed. For more information, refer to the rooms Object table.
levels	object	Object that contains detailed information on the proficiency/difficulty level of the class sessions. For more information, refer to the levels Object table.
opening_time	datetime	The time at which the class sessions begin at the specified centers.
page_details	object	Object that contains the number of search results in the API response, number of pages of search results, and number of search results displayed per page.
error	object	Object that contains error message and error code details. For more information, refer to the Error Object table.

sessions Object

Name	Type	Description
id	int	Unique identifier of the booked session.
name	string	Name of the booked session.
class_id	int	Unique identifier of the class.
start_time	datetime	Starting time of the booked session.
end_time	datetime	Ending time of the booked session.
strat_time_utc	datetime	Starting time of the booked session in UTC time zone.
end_time_utc	datetime	Ending time of the booked session in UTC time zone.
price	double	Price of the booked session.
instructor_id	guid	Unique 32-character identifier of the instructor who will perform the booked session.
assistant_id	guid	Unique 32-character identifier of the instructor's assistant who will help perform the booked session.
room_id	guid	Unique 32-character identifier of the room in which the booked session will be performed.
status	enum	Indicates the class session status: Active = 0, Cancelled = 1, Upcoming = 2, Inprogress = 3, and Completed = 4.
recurrence_id	int	Unique identifier of the recurrences of the registered session.
center_id	guid	Unique 32-character identifier of the center in which the booked session will be performed.
center_name	string	Name of the center in which the booked session will be performed.
registration_id	int	Unique identifier of the class session for which the guest was registered.
registration_status	int	Unique identifier of the status of registration of the class session.
is_free_session	boolean	Indicates whether the booked session is free of cost for the guest.
can_book	boolean	Indicates whether the guest can book the class session.
can_cancel	boolean	Indicates whether the guest can cancel the booked session.
booking_stage	int	Stage of the session-booking process.
capacity	int	Maximum number of guests who can accommodated in the session.
web_capacity	int?	Maximum number of guests who can be accommodated in the online session.
wait_listed_count	int?	Number of guests who have been waitlisted for the session.
occupancy	int	Occupancy of the session.
web_occupancy	int	Occupancy of the online session.
cancel_stage	int	Stage of the session-cancellation process.
description	string?	Description of the booked session.
html_description	string?	Description of the session in HTML.
available_slots	int?	Number of slots available for the class session.
current_waitlist_position	int?	Current position of the guest in the waitlist for the class session.
can_book_status_id	string	Indicates the identifier of the status of the guest's class-booking request.
can_book_status	string	Indicates the the status of the guest's class-booking request.
cancellation_fee_window	int	Number of days within which guests must pay the cancellation fee for the session.
cancellation_fee	double	Cancellation fee that guests must pay for the session.
is_instructor_substituted	boolean	Indicates whether the instructor for the class is a substitute.

classes Object

Name	Type	Description
id	int	Unique identifier of the class.
name	string?	Name of the class.
category_id	int	Unique identifer of the category to which the class belongs.
start_date	datetime?	Starting date of the class.
end_date	datetime?	Ending date of the class.
description	string?	Description of the class.
html_description	string?	Description of the class in HTML.
catalog_price	double	Catalog price of the class.
capacity	int	Maximum number of guests who can accommodated for the class.
allow_web_booking	boolean	Indicates whether guests can book the class online.
allow_direct_booking	boolean	Indicates whether guests can book the class directly at the center.
allow_cancellation_fee	boolean	Indicates whether guests must pay a cancellation fee for the class.
allow_no_show_fee	boolean	Indicates whether guests must pay a no-show fee for the class.
display_name	string?	Display name of the class.
show_in_catalog	int	Indicates whether the calss will be displayed in the catalog.
sort_order	int	Indicates the sorted order of the classes.
show_price	boolean	Indicates whether the price of the class is to be displayed.
allow_wait_list	boolean?	Indicates whether guests can be waitlisted for the class.
wait_list_lock_window	int	Number of days within which guests can be waitlisted for the class.
enable_enrol	boolean	Indicates guests can enroll for the class.
level_id	int	Unique identifier of the level to which the class belongs.
registration_notes	string	Notes on the guest's registration for the class.
enable_payments	boolean	Indicates whether guests can make payments for the class via different payment methods.
image_paths	dictionary?	Name-value pairs of class images that contain pixel sizes and location respectively.
min_time	datetime?	Minimum start time for all the sessions that belong to this class.
max_time	datetime?	Maximum start time for all the sessions that belong to this class.
web_capacity	int?	Maximum number of guests who can be accommodated in the online class.
registration_lock_window	decimal	Number of hours before which guests are allowed to register for the class. For example, if the class is at 5 PM and `registration_lock_window` = 1, guests can register for the class only until 4 PM.
auto_confirm_lock_window	decimal	Number of hours before which waitlisted guests are automatically confirmed for a class (if vacant slots are available). For example, if the class is at 5 PM, `auto_confirm_lock_window` = 1, and vacant slots for the class are available, waitlisted guests are automatically confirmed for the class only until 4 PM.
sac	string	Services Accounting Code (SAC) details for the class.
type	enum	Indicates the type of the class: 1 - Class, 2 - Class, and 3 - Workshop.

instructors Object

Name	Type	Description
id	guid	Unique 32-character identifier of the instructor who will perform the class session.
name	string	Name of the instructor.
description	string	Detailed information on the instructor.
image_paths	string?	Navigation path of the image used to illustrate the instructor.

categories Object

Name	Type	Description
id	int	ID of the category of the class session.
name	string	Name of the category of the class session.
parent_id	int	Parent ID of the category of the class session.

rooms Object

Name	Type	Description
id	guid	Unique 32-character identifier of the room in which the class session is to be performed.
name	string	Name of the room in which the class session is to be performed.

levels Object

Name	Type	Description
id	int	ID of the level of the class session.
code	string	Code of the level of the class session.
name	string	Name of the level of the class session.
description	string?	Description of the level of the class session.
html_description	string?	Description of the level of the class session.

error Object

code	message
500 - Invalid Data	Something went wrong.