Appointments

Entity›Activity›Activity.Appointment

Appointments represent scheduled meetings and calendar entries in your CRM. They have a defined start and end time, an owner, and can be linked to relationships and contacts.

Use the Activity_Appointment endpoint to manage appointments. Appointments inherit all fields from Activity and add scheduling-specific fields like StartDate, EndDate, Owner, and Description.

Endpoints

List Appointments

GET/v1/odata/Activity_Appointment

Single Appointment

GET/v1/odata/Activity_Appointment({id})

With expanded relations:

GET/v1/odata/Activity_Appointment({id})?$expand=Owner,Phase

Create Appointment

POST/v1/odata/Activity_Appointment

Update Appointment

PUT/v1/odata/Activity_Appointment({id})

Delete Appointment

DELETE/v1/odata/Activity_Appointment({id})

Fields

Appointment Fields

Field	Type	Description
Description	String	Appointment description
StartDate	DateTimeOffset	Start date and time
EndDate	DateTimeOffset	End date and time

Inherited Fields (from Activity)

See Activity Fields for all inherited fields.

Relationships

Relationship	Target Entity	Cardinality	Description
Owner	Relationship.Person.Contact.Employee	N:1	Appointment owner
Relationship	Relationship	N:1	Linked relation
Contact	Relation.Person.Contact	N:1	Contact person
Phase	Datastore.Phase.ActivityAppointment	N:1	Appointment phase
LinkedActivities	Activity	1:N	Linked activities

Expanding Relationships

GET/v1/odata/Activity_Appointment({id})?$expand=Owner

Navigating Relationships

GET/v1/odata/Activity_Appointment({id})/Owner

Filtering Examples

GET/v1/odata/Activity_Appointment?$filter=StartDate gt {StartDate}&$top={top}

GET/v1/odata/Activity_Appointment?$filter=EndDate lt {EndDate}&$top={top}

GET/v1/odata/Activity_Appointment?$filter=contains(Description, '{Description}')&$top={top}

GET/v1/odata/Activity_Appointment?$filter=IsClosed eq {IsClosed}&$top={top}