Retrieve the details of an appointment

Request Details

Name	Type	Description
appointment_id	guid	Unique 32-character ID of the appointment.

Response object

Appointment Details

Json Property	Type	Description
id	Guid	Unique 32-character ID of the appointment.
appointment_segment_id	Guid	Unique 32-character ID of the appointment segment.
appointment_group_id	Guid	Unique 32-character ID of the appointment group.
invoice_id	Guid	Unique 32-character ID of the invoice.
service	Object	Object that contains information on various service-related elements. Refer to the service table below.
start_time	DateTime	Start date and time of the appointment.
start_time_utc	DateTime	Start date and time of the appointment in Coordinated Universal Time (UTC).
end_time	DateTime	End date and time of the appointment.
end_time_utc	DateTime	End date and time of the appointment in Coordinated Universal Time (UTC).
status	Enum	Indicates the status of the appointment.
source	Enum	Indicates the source from which the guest booked the appointment.
progress	Enum	Indicates the progress of the appointment.
locked	Boolean	Indicates if the appointment booking is locked.
invoice_locked	Boolean	Indicates if the invoice for the appointment booking is locked.
has_active_membership_for_auto_pay	Boolean	Indicates if the guest has an active membership for automatic payment of the invoice.
guest	Object	Object that contains information on various guest-related elements. Refer to the guest table below.
therapist	Object	Object that contains information on various therapist-related elements. Refer to the therapist table below.
room	Object	Object that contains information on various room-related elements: `name` and `id`.
equipment	Object	Object that contains information on various equipment-related elements: `name` and `id`.
service_custom_data_indicator	String	Represents any custom data added for the service(s) in the appointment.
notes	String	Any notes that have been added for the appointment.
price	Object	Object that contains information on various price-related elements.
actual_start_time	DateTime	Date and time at which the appointment actually started.
actual_completed_time	DateTime	Date and time at which the appointment actually ended.
checkin_time	DateTime	Date and time at which the guest checked in.
therapist_preference_type	Enum	Indicates the gender of the requested therapist.
form_id	Guid	Unique 32-character ID of the form that is associated with the invoice.
blockout	Object	Object that contains information on various break category-related elements of the employee. Refer to the blockout table below.
creation_date	DateTime	Date and time on which the appointment was created.
creation_date_utc	DateTime	Date and time on which the appointment was created in Coordinated Universal Time (UTC).
created_by_id	Guid	Unique 32-character ID of the employee who created the appointment.
closed_by_id	Guid	Unique 32-character ID of the employee who closed the appointment.
show_in_calendar	Integer	Indicates whether the appointment is shown in the appointment booking calendar.
available_therapists	Object	Object that contains information on various available therapists-related elements. Refer to the available_therapists table below.
available_rooms	Object	Object that contains information on various available rooms-related elements: `name` and `id`.
available_times	DateTime	Dates and times on which the slot is available to be booked for the appointment.
selected_therapist_id	Guid	Unique 32-character ID of the selected therapist for the appointment.
selected_room_id	Guid	Unique 32-character ID of the selected room for the appointment.
selected_time	DateTime	Date and time selected for the appointment.
requested_alternative	Enum	Indicates the alternative items requested by the guest.
group_invoice_id	Guid	Unique 32-character ID of the group invoice for the appointment.
group_name	String	Name of the group to which the appointment is associated.
error	String	Details of any error message.

Service

Name	Type	Description
id	Guid	Unique 32-character ID of the service that is part of the appointment.
name	String	The name of the service.
is_addon	Boolean	Indicates if the service is included as an add-on.
has_addons	Boolean	Indicates if the service includes add-ons.
parent_appointment_id	Guid	Unique 32-character ID of the parent appointment.
business_unit	Object	Object containing information on various business unit-related elements: `guid`, `name`, and `id`.
category	Object	Object containing information on various service category-related elements: `name` and `id`.
sub_category	Object	Object containing information on various service subcategory-related elements: `name` and `id`.
override_product_consumption	Boolean	Indicates if the override product consumption setting for the service is enabled.
override_default_product_consumption	Boolean	Indicates if the override default product consumption setting for the service is enabled.

Guest

Name	Type	Description
id	Guid	Unique 32-character ID of the guest.
first_name	String	First name of the guest.
last_name	String	Last name of the guest.
gender	Enum	Indicates gender of the guest.
mobile	Object	Object containing details of various mobile number-related elements of the guest: `country_id`, `number`, and `display_number`.
email	String	Email ID of the guest.
indicator	String	Represents the indicator of the guest.
lp_tier_info	String	Represents the loyalty tier information of the guest.
GuestIndicatorValue	Object	Object containing details of various guest indicator value-related elements.
preferred_pronoun	string	Preferred pronoun of the guest, with null value handling for ignoring

Therapist

Name	Type	Description
id	Guid	Unique 32-character ID of the therapist.
first_name	String	First name of the therapist.
last_name	String	Last name of the therapist.
nick_name	String	Nickname of the therapist.
display_name	String	Display name of the therapist.
email	String	Email ID of the therapist.
gender	Enum	Indicates gender of the therapist.
vanity_image_url	String	URL of a photo of the therapist.

Available Therapists

Name	Type	Description
id	Guid	Unique 32-character ID of the available therapist.
first_name	String	First name of the available therapist.
last_name	String	Last name of the available therapist.
nick_name	String	Nickname of the available therapist.
display_name	String	Display name of the available therapist.
email	String	Email ID of the available therapist.
gender	Enum	Indicates gender of the available therapist.
vanity_image_url	String	URL of a photo of the available therapist.

Blockout

Name	Type	Description
id	Guid	Unique 32-character ID of the blockout.
name	String	Name of the blockout.
code	String	Code of the blockout.
description	String	Description of the blockout.
duration	Integer	Duration of the blockout.
active	Boolean	Indicates if the blockout is active.
count_in_utilization	Boolean	Indicates if the blockout count is included in utilization.
bookable	Boolean	Indicates if the blockout is bookable.
indicator_color	String	Color indicator of the blockout.
text_color	String	Color of the text for the blockout.