Appointments

Retrieve the available Appointments in HubSpot.

Table Specific Information

In HubSpot, appointments represent scheduled meetings, consultations, or other time-based interactions with contacts or prospects. Appointment records help users track and manage scheduled activities through pipeline stages.

SELECT

When selecting appointments, filtering can be applied to columns marked as "Filterable." For these columns, the only supported server-side operator is =.

SELECT * FROM Appointments WHERE ID = '96ec8565-3b73-4ee8-9815-f90566ba9c42'

INSERT

INSERT INTO Appointments ([Appointment Name]) VALUES ('Client Consultation')

UPDATE

UPDATE Appointments SET [Appointment Name] = 'Updated Consultation' WHERE ID = '25151'

DELETE

DELETE FROM Appointments WHERE ID = '25151'

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	Long	True		True	Unique identifier of the object.
Archived	Bool	True		False	Whether the object is archived or not.
CreatedAt	Datetime	True		False	When the object was created.
UpdatedAt	Datetime	True		False	When the object was last updated.
All teams	String	True		False	The team IDs, including the team hierarchy, of all default and custom owner properties for this record.
Business units	String	False		False	The business units this record is assigned to.
All owner IDs	String	True		False	Values of all default and custom owner properties for this record.
All team IDs	String	True		False	The team IDs of all default and custom owner properties for this record.
Appointment End	Datetime	False		True	Date and time when the appointment ends.
Appointment Name	String	False		True	Name or title of the appointment.
Appointment Start	Datetime	False		True	Date and time when the appointment begins.
Created by user ID	Decimal	True		True	The user who created this record. This value is set automatically by HubSpot.
Object create date/time	Datetime	True		True	The date and time at which this object was created. This value is automatically set by HubSpot and may not be modified.
Date entered 'In Progress (Appointment Pipeline)'	Datetime	True		True	The date and time when the Appointment entered the 'In Progress' stage, 'Appointment Pipeline' pipeline.
Date entered 'Canceled (Appointment Pipeline)'	Datetime	True		True	The date and time when the Appointment entered the 'Canceled' stage, 'Appointment Pipeline' pipeline.
Date entered 'Scheduled (Appointment Pipeline)'	Datetime	True		True	The date and time when the Appointment entered the 'Scheduled' stage, 'Appointment Pipeline' pipeline.
Date entered 'Rescheduled (Appointment Pipeline)'	Datetime	True		True	The date and time when the Appointment entered the 'Rescheduled' stage, 'Appointment Pipeline' pipeline.
Date entered 'Completed (Appointment Pipeline)'	Datetime	True		True	The date and time when the Appointment entered the 'Completed' stage, 'Appointment Pipeline' pipeline.
Date exited 'In Progress (Appointment Pipeline)'	Datetime	True		True	The date and time when the Appointment exited the 'In Progress' stage, 'Appointment Pipeline' pipeline.
Date exited 'Canceled (Appointment Pipeline)'	Datetime	True		True	The date and time when the Appointment exited the 'Canceled' stage, 'Appointment Pipeline' pipeline.
Date exited 'Scheduled (Appointment Pipeline)'	Datetime	True		True	The date and time when the Appointment exited the 'Scheduled' stage, 'Appointment Pipeline' pipeline.
Date exited 'Rescheduled (Appointment Pipeline)'	Datetime	True		True	The date and time when the Appointment exited the 'Rescheduled' stage, 'Appointment Pipeline' pipeline.
Date exited 'Completed (Appointment Pipeline)'	Datetime	True		True	The date and time when the Appointment exited the 'Completed' stage, 'Appointment Pipeline' pipeline.
Duration	Decimal	True		True	Total length of the appointment.
Object last modified date/time	Datetime	True		True	Most recent timestamp of any property update for this object. This includes HubSpot internal properties, which can be visible or hidden. This property is updated automatically.
Merged record IDs	String	True		False	The list of record IDs that have been merged into this record. This value is set automatically by HubSpot.
Record ID	Decimal	True		True	The unique ID for this record. This value is set automatically by HubSpot.
Record creation source	String	True		True	Raw internal PropertySource present in the RequestMeta when this record was created.
Record source detail 1	String	True		True	First level of detail on how this record was created.
Record source detail 2	String	True		True	Second level of detail on how this record was created.
Record source detail 3	String	True		True	Third level of detail on how this record was created.
Record creation source ID	String	True		True	Raw internal sourceId present in the RequestMeta when this record was created.
Record source	String	True		False	How this record was created.
Record creation source user ID	Decimal	True		True	Raw internal userId present in the RequestMeta when this record was created.
Owning Teams	String	False		False	The teams that are attributed to this record.
Pipeline	String	False		False	The pipeline that contains this appointment.
Pipeline Stage	String	False		False	The pipeline stage that contains this appointment.
Read only object	Bool	True		True	Determines whether a record can be edited by a user.
Shared teams	String	False		False	Additional teams whose users can access the record based on their permissions. This can be set manually or through Workflows or APIs.
Shared users	String	False		False	Additional users that can access the record based on their permissions. This can be set manually or through Workflows and APIs.
Time in 'In Progress (Appointment Pipeline)'	Decimal	True		True	The total time in seconds spent by the Appointment in the 'In Progress' stage, 'Appointment Pipeline' pipeline.
Time in 'Canceled (Appointment Pipeline)'	Decimal	True		True	The total time in seconds spent by the Appointment in the 'Canceled' stage, 'Appointment Pipeline' pipeline.
Time in 'Scheduled (Appointment Pipeline)'	Decimal	True		True	The total time in seconds spent by the Appointment in the 'Scheduled' stage, 'Appointment Pipeline' pipeline.
Time in 'Rescheduled (Appointment Pipeline)'	Decimal	True		True	The total time in seconds spent by the Appointment in the 'Rescheduled' stage, 'Appointment Pipeline' pipeline.
Time in 'Completed (Appointment Pipeline)'	Decimal	True		True	The total time in seconds spent by the Appointment in the 'Completed' stage, 'Appointment Pipeline' pipeline.
Unique creation key	String	True		True	Unique property used for idempotent creates.
Updated by user ID	Decimal	True		True	The user who last updated this record. This value is set automatically by HubSpot.
User IDs of all notification followers	String	True		False	The user IDs of all users that have clicked follow within the object to opt-in to getting follow notifications.
User IDs of all notification unfollowers	String	True		False	The user IDs of all object owners that have clicked unfollow within the object to opt-out of getting follow notifications.
User IDs of all owners	String	True		False	The user IDs of all owners of this record.
Performed in an import	Bool	True		True	Object is part of an import.
Owner assigned date	Datetime	True		True	The most recent timestamp of when an owner was assigned to this record. This value is set automatically by HubSpot.
Owner	String	False		True	The owner of the object.
Owner's main team	String	True		False	The main team of the record owner. This value is set automatically by HubSpot.
Test Label	String	False		True	This column is a custom field.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source. For more information, see the WHERE clause section.


Name	Type	Description
ExternalIdColumn	String	The name of the column to be used as the unique key in a bulk UPSERT statement.

CData Python Connector for HubSpot