get https://api.zenoti.com/v1/queue?CenterId=
Purpose : Use this API to list all the appointments in your queue.
You must specify center_id to list all the appointments in a queue for a center. Optionally, you can also add guest_id to show all the appointments in queue for a guest of a center.
Example: GET: http://{apiurl}/v1/queue?CenterId={center_id}&GuestId={guest_id}
Name Type Description queue object Object containing the information of the appointments in queue. guest object Object containing the information of the guests whose appointments are in the queue. employee object Object containing the information of the employees who have scheduled appointments in the queue.
Name Type Description order int Denotes the order of the appointment in the queue. preferred_time date & time Denotes the date and time of the appointment in the queue. wait_time_in_min int Denotes the waiting time for the guest. appointment object Object containing the appointment details in the queue. service object Object containing the service details. guest object Object containing the guest details. employee object Object containing the employee details who is providing the serivce.
Name Type Description id id Unique identifier of the appointment. parent_id id Unique identifier of the parent appointment. booking_type string Denotes the type of booking. group_id guid Unique identifier of the group appointment. group_invoice_id guid Unique identifier of the invoice of the group appointment. status int Status of the appointment. source int The referral source of the appointment in the queue. progress int Denotes the progress of the appointment in the queue. notes string Notes of the appointment. invoice_id guid Unique identifier of the invoice. price num Denotes the price to be paid by the guest. is_price_paid bool Denotes if the price is already paid by the guest. start_time_in_center date & time Denotes the start time of the appointment in the center. end_time_in_center date & time Denotes the end time of the appointment in the center. checkin_time_in_center date & time Denotes the check-in time of the stylist/therapist at the center. actual_completed_time_in_center date & time Denotes the appointment completed time. actual_start_time_in_center date & time Denotes the appointment start time.
Name Type Description id guid Unique identifier of the service. name string Name of the service. duration int Duration of the service. category_id guid Unique identifier of the service category. is_addOn bool Denotes if the service is an add-on. True: The service is an add-on. False: The service is not an add-on. has_addOns bool Indicates if the service has any add-ons. True: The service has add-ons associated with it. False: The service does not have any associated add-ons.
Name Type Description id guid Unique identifier of the guest. first_name string First name of the guest. last_name string Last name of the guest. phone string Phone number of the guest. email string Email address of the guest.
Name Type Description id guid Unique identifier of the employee who is providing the service to the guest. display_name string Name of the employee that is shown on the queue. gender string Gender of the employee (stylist/therapist) M: Male, F: Female. nick_name string Nick name of the employee as per the employee profile in Zenoti. full_name string Full name of the employee as per the employee profile in Zenoti. first_name string First name of the employee as per the employee profile in Zenoti. last_name string Last name of the employee as per the employee profile in Zenoti. preference_type string Denotes if the employee is preferred for "Any", "Specific", "Male" or "Female".
Message Code Description Invalid CenterId QA014 This message appears when no center_id is provided. Invalid CenterId QA014 This message appears when the center_id is invalid.
