SOAP API calls
IMPORTANT The SOAP API entered a limited enhancement phase in Q4 2020. Access deactivation for version 1.5 began in Q1 2022 and will enter its concluding phases in October 2022. Access to version 1.6 will be deactivated in Q4 2024. Visit our SOAP API lifecycle FAQ article to learn more.
The Web Services SOAP API calls allow you to create, query, and update the Autotask entities available in the API. Not all API calls are available for each entity type.
Additional calls, The getEntityInfo() SOAP API call, The getFieldInfo() SOAP API call, and getUDFInfo(), allow you to retrieve information on all currently available entities, entity fields, and entity user-defined fields.
getZoneInfo() and getThresholdAndUsageInfo() return information about your access to the API, for example, which zone your Autotask application uses and your threshold level and the number of requests made within the previous hour.
NOTE Autotask Web Services API stores and returns all time data in Coordinated Universal Time (UTC).
The Attachment API calls allow you to create, delete, and retrieve attachments. They are unique to managing Autotask Attachments through the API.
API call descriptions
The API currently includes the following calls. For additional details on any call, including sample code, click the call name.
| Attachment API calls - CreateAttachment(), GetAttachment(), DeleteAttachment() | Exclusive to the AttachmentInfo entity, you must use these API calls to create, retrieve, and delete Autotask attachments by using the Web Services API. |
| create() | Use the create() API call to add new objects in the Autotask system. |
| delete() | Use the delete() API call to remove objects in the Autotask system. |
| query() | Executes a query against Autotask and returns an array of matching entities. |
| update() | Use this call to update objects in the Autotask system. |
| The getEntityInfo() SOAP API call | Returns an array of EntityInfo objects that contain descriptive information about each available Autotask Web Service entity. |
| The getFieldInfo() SOAP API call | Returns an array of the standard Autotask fields for a specified entity with descriptive information about each field. |
| GetInvoiceMarkup() | Returns the invoice data available from the Autotask UI invoice XML export. Data format is XML or HTML. |
| getThresholdAndUsageInfo() | Returns the number of external requests allocated for a specific database, the timeframe measured, and the current number of external requests |
| getUDFInfo() | Returns an array of all user-defined fields (UDF), that is, non-standard fields, for a specified entity. |
| getWsdlVersion() | Returns the WSDL version being accessed by the logged in end user. |
| getZoneInfo() | Returns the proper zone URL to be used for all subsequent API calls. |
For information on the return values for ATWSResponse and ATWSError, see API return values.
Batching of API calls
The Web Services API also supports the batching of API calls. This can provide performance gains over separate Web Service calls for each action, since you do not incur any overhead for a separate request, response and the authentication that need to occur with separate requests.
Refer to Batching of SOAP API calls.
Call conditions limit
You can include up to 500 OR conditions in a single call to the API. If a call contains more than 500 OR statements, you will receive the API response, "Invalid query syntax. Queries are limited to 500 or fewer 'OR' conditions."
