Appointment

IMPORTANT  The SOAP API entered a limited enhancement phase in Q4 2020. Access to version 1.6 will be deactivated.

The Appointment entity describes an Autotask Appointment, that is, scheduled time that is not a service call. Autotask users manage appointments through their calendar. In addition, Dispatchers can view and schedule appointments through the Dispatcher's Workshop.

Entity details

You can also retrieve this information with the Web Services API call The getEntityInfo() SOAP API call.

Entity Name: Appointment
Can Create:
Can Update:
Can Query:
Can Delete:
Can Have UDFs:  

Conditions and Requirements

All users can create, update, and delete only their own appointments. Users whose security level allows access to Admin > Resources or access to All tickets, and the Autotask service desk system setting "Allow users that can view all tickets to create, edit, and delete appointments for other resources" is enabled can manage appointment for other users.

Field definitions

The following table describes the standard Autotask field objects for this entity.

  • To retrieve more detailed information specific to a particular Autotask implementation, use the Web Services API call The getFieldInfo() SOAP API call.
  • For information on entity UDFs, use getUDFInfo().
  • For String datatypes, the number in parentheses ( ) indicates the maximum number of characters allowed.
  • LT indicates Local Term.

For more information about fields marked as picklists, review our Understanding picklists article.

Field Name Label Datatype Read Only Is Required Reference Name Picklist
CreateDateTime Create Date datetime      
CreatorResourceID Created By integer   Resource  
Description Description string (8000)        
EndDateTime End Date datetime      
id id long    
ResourceID Resource integer   Resource  
StartDateTime Start Date datetime      
Title Appointment Title string (256)      
UpdateDateTime Update Date datetime