get https://api.zenoti.com/v1/appointments
This API retrieves the list of all appointments of the specified center between the start date and end date.
You must provide appropriate details for the center_id, start_date, and end_date parameters. Optionally, you can also specify the details for the include_no_show_cancel and therapist_id parameters to filter the results.
The difference between the start_date and end_date cannot be more than seven days.
The response also includes block-out times.
Response object
| 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 |
| gender | NewGender / enum | Gender of the guest |
| mobile | PhoneViewModel / object | Phone number of the guest |
| string | Email address of the guest | |
| indicator | string | Indicator of the guest |
| lp_tier_info | string | Loyalty program tier information of the guest |
| is_virtual_user | bool | Indicates whether the guest is a virtual user or not |
| preferred_pronoun | string | Preferred pronoun of the guest, with null value handling for ignoring |
| GuestIndicatorValue | Api.Model.Custom.GuestIndiCatorValue | Custom indicator value of the guest |
| appointment_id | Guid | Unique identifier of the appointment |
| appointment_segment_id | Guid | Unique identifier of the appointment segment |
| appointment_group_id | Guid | Unique identifier of the appointment group |
| invoice_id | Guid | Unique identifier of the invoice |
| service.id | Guid | Unique identifier of the service |
| service.name | string | Name of the service |
| service.is_addon | bool | Indicates whether a service is an add-on |
| service.has_addons | bool | Indicates whether a service contains an add-on |
| service.parent_appointment_id | Guid | Unique identifier of the parent appointment |
| service.business_unit.guid | Guid | Unique identifier of the business unit |
| service.business_unit.name | string | Name of the business unit |
| service.business_unit.id | long | Unique key given to the business unit |
| service.category.id | Guid | Unique identifier of the category |
| service.category.name | string | Name of the category |
| service.sub_category.id | Guid | Unique identifier of the sub-category |
| service.sub_category.name | string | Name of the sub-category |
| service.override_product_consumption | bool | Allows product consumption entry in the Appointment Book |
| service.override_default_product_consumption | bool | Allows to override automatic product consumption in Appointment Book |
| start_time | datetime | Start time of the appointment in the center time zone |
| start_time_utc | datetime | Start time of the appointment in UTC format |
| end_time | datetime | End time of the appointment in the center time zone |
| end_time_utc | datetime | End time of the appointment in UTC format |
| status | enum | Indicates the status of the appointment |
| source | enum | Indicates the source of the appointment |
| progress | enum | Indicates the progress of the appointment |
| locked | bool | Indicates whether the appointment is locked |
| invoice_locked | bool | Indicates whether an invoice is locked |
| has_active_membership_for_auto_pay | bool | Indicates whether an appointment has memberships for auto pay |
| therapist.id | Guid | Unique identifier of the therapist |
| therapist.first_name | string | First name of the therapist |
| therapist.last_name | string | Last name of the therapist |
| therapist.nick_name | string | Nick name of the therapist |
| therapist.display_name | string | Display name of the therapist |
| therapist.email | string | Email ID of the therapist |
| therapist.gender | enum | Gender of the therapist |
| therapist.vanity_image_url | string | Image URL of the therapist |
| room | object | Object that contains details of the room used in the appointment |
| equipment | object | Object that contains details of the equipment used in the appointment |
| service_custom_data_indicator | string | Indicator of the service custom data |
| notes | string | Notes added for the appointment |
| price | object | Object that contains pricing details of the appointment |
| actual_start_time | datetime | Actual start time of the appointment |
| actual_completed_time | datetime | Actual completion time of the appointment |
| checkin_time | datetime | Check-in time of the guest |
| therapist_preference_type | enum | Requested gender type of the therapist |
| form_id | Guid | Unique identifier of the form |
| blockout | object | Object that contains block out time details |
| creation_date | datetime | Creation date of the appointment in the center time zone |
| creation_date_utc | datetime | Creation date of the appointment in UTC format |
| created_by_id | Guid | Unique identifier of the employee who created the appointment |
| closed_by_id | Guid | Unique identifier of the employee who closed the appointment |
| show_in_calender | int | If 1, the appointment is shown in the calendar |
| available_therapists | array | List of therapist objects |
| available_rooms | array | List of room objects |
| available_times | array | List of available times |
| selected_therapist_id | Guid | Unique identifier of the selected therapist |
| selected_room_id | Guid | Unique identifier of the selected room |
| selected_time | datetime | Preferred appointment time |
| requested_alternative | enum | Requested alternative options |
| group_invoice_id | Guid | Unique identifier of the group invoice |
| Error | object | Object that contains error message and error code details |
| mobile.country_id | long | Unique identifier of the country code for the guest's mobile number |
| mobile.number | string | Mobile number of the guest |
| mobile.display_number | string | Displayed mobile number of the guest |