Appointment

An appointment represents a meeting or calendar event between attendees.

Attributes

Attribute	Type	Description
id	Integer	The unique id of the Appointment.
tenant_id	Integer	The id of the Tenant the Appointment belongs to.
company_id	Integer	The id of the Company the Appointment belongs to.
project_id	Integer	The id of the Project the Appointment belongs to.
created_by	Integer	The id of the User who created the Appointment.
title	String	The title or subject of the Appointment.
description	String	The description or body of the Appointment.
starts_at	DateTime	The date time of when the Appointment starts.
ends_at	DateTime	The date time of when the Appointment ends.
slot_type	String	Defines how the appointment functions. Either "placeholder" or "confirmed".
created_at	DateTime	The date time of when the Appointment was created.
updated_at	DateTime	The date time of when the Appointment was last updated.

Allowed includes

Relation	Type	Description
company	Company	The Company the Appointment belongs to.
project	Project	The Project the Appointment belongs to.
account	Account	The corresponding Account related to the Appointment.

Allowed filters

Name	Type	Description
id	Integer	Filter Appointments by their id.
company_id	Integer	Filter Appointments by their company.
project_id	Integer	Filter Appointments by by their project.
slot_type	Integer	Filter Appointments by their slot type.
nearby	Array	Filter Appointments to a specific geographical location (lat,lon,radius).
search	String	Filter Appointments by a specific search term.
date_range	Array	Filter Appointments that fit into a specific date range (start,end).

Allowed sorts

Name	Description
starts_at	Sort Appointments by their start time.
ends_at	Sort Appointments by their end time.
created_at	Sort Appointments by when they where created.
updated_at	Sort Appointments by when they where last updated.