Fetch a list of booked users of a Workshop event

Response Details

Name	Type	Description
registrations	object	Object containing the list of all the booked users to a workshop event.
page_details	object	Object containing the pagination details of the API response.
status_count	object	Object containing the status count.
occupancy	int	Denotes the occupancy of the workshop event.
session	object	Object containing the session details

registrations Object

Name	Type	Description
id	id	Registration id of the guest.
delete_status	string	Denotes the delete status of the guest's registration to the workshop.
guest	object	Object containing the details of the guest.
session_id	int	Denotes the id of the session of the guest.
indicators	string	Denotes the indicators for the registration.
log_data	string	Log data of the guest's registration
payment_type	string	Payment type used for the payment of the registration of the workshop.
payment_source	string	Payment source used for the payment of the registration of the workshop.
booked_from	string	Denotes the source of booking for the registration of the workshop.
registration_source	string	Denotes the source of the registration for the workshop - Zenoti
is_free	enum	Denotes if the registration for the workshop is free. (no charge)
is_from_waitlist	bool	Denotes if the registration is from the waitlist. True: The registration is from the waitlist. False: The registration is not from the waitlist.
status	enum	Denotes the status of the registration to the workshop.
is_any_session_noshow	bool	Denotes if any of the sessions are a no-show by the guest.
invoice_id	id	Denotes the invoice id for the workshop.
appointment_group_id	id	Unique identifier of the group appointment.
appointment_ids	array	Unique identifier of the appointment.
registration_dt	datetime	Registration date of the workshop.
notes	string	Notes on the guest's workshop registration.
user_code	string	Code of the registration.
redemption_type	string	Redemption type of the guest's registration.
sort_order	int	API response's sort order.
last_updated	datetime	Date and time when the registration of the workshop was updated.
balance	int	Loyalty points balance for the workshop registration.

guest Object

Name	Type	Description
id	id	Unique identifier of the guest.
name	string	Name of the guest.
phone	string	Phone number of the guest.
code	int	Unique code of the guest.
email	string	Email address of the guest.

status_count Object

Name	Type	Description
registered	int	Registered users for the workshop event
waitlisted	int	Number of waitlisted guests for the event
total	int	Total guests present in the event
closed	int	Number of guests whose registration is completed
signed_in	int	Number of guests signed in for the workshop
canceled	int	Number of guests who canceled the workshop event
open	int	Number of guests whose registration is not completed
enrolled	int	Number of guest enrolled for the event
rejected	int	Number of guests rejected by the center.
web	int	Number of guests who booked online.
occupancy	int	Number of guests attending the event.

session Object

Name	Type	Description
id	long	Identifier of the session.
name	string	Name of the session.
code	string	Code of the session.
start_time	datetime	Start time of the session.
end_time	datetime	End time of the session.
start_time_utc	datetime	Start time of the session as per UTC.
end_time_utc	datetime	End time of the seesion as per UTC.
duration	int	Total duration of the session.
center_id	guid	Unique identifier of the center.
class_id	long	Identifier fo the class.
instructor_id	guid	Unique identifier of the instructor.
instructor_details_list	object	Object containing the details of the instructor
room_id	guid	Identifier of the room.
status_id	int	Status of the session.
recurrence_id	long	Identifier for the recurring session.
catalog_name	string	Name of the catalog
catalog_price	string	Price of the session as mentioned in the catalog.
show_in_catalog	int	Denotes if the session has the catalog enabled.
capacity	int	Total capacity of the class.
web_capacity	int	Total capacity of the web session.
occupancy	int	Total occupancy for the class.
web_occupancy	int	Total web occupancy for the class.
available_slots	int	Number of available slots for the class.
waitlisted_count	int	Total count of students in the waitlist.
is_open_for_registration	bool	Denotes if the class is open for registration.
is_cancelled	bool	Denotes if the class is canceled.
is_free_session	bool	Denotes if the session is free.
description	string	Workshop description
description_html	string	HTML version of the workshop description.
track_ids	list (int)	List of the track ids.
service_id	guid	Identfier of the serivce.
active_request_id	long	Identifier of the active request.
cancellation_fee_window	int	Time period before which the cancelation is allowed.
cancellation_fee	decimal	Amount for the cancelation fee.
allow_cancellation_fee	bool	Denotes if cancelation fee is enabled
student_virtual_link	string	Virtual class link for the student.
instructor_virtual_link	string	Virtual class link for the instructor.
virtual_type	string	Type of the virtual workshop.
is_instructor_substituted	bool	Denotes if the instructor is a substitute.
level_id	guid	Identifier of the session level
session_last_updated_time	datetime	Denotes when the session was updated.

instructor_details_list Object

Name	Type	Description
id	guid	Unique identifier of the instructor.
is_primary	bool	Denotes if the instructor is a primary instructor