Version

This entity surfaces the Autotask version number.

NOTE  You can refer to the Online Help to find root and child access URLs of the entity you wish to query. Refer to Finding resource and child access URLs of REST API entities for more information.

Entity details

Entity Name: Version

Entity Path:

/atservicesrest/v1.0/Version
Can Create:  
Can Update:  
Can Query:
Can Delete:  
Can Have UDFs:  

Conditions and requirements

General

  • This entity is unique. You can only query it.

  • Standard authentication is required to obtain version information. The only requirement is that the API call successfully authenticates.

Querying version information

The purpose of this endpoint is to provide a mechanism for determining, via the API, the version of Autotask in which your integration is operating. This entity functions as an endpoint only. You can only query it.

Query the Version endpoint as follows:

                    https://webservices[n].autotask.net/atservicesrest/v1.0/Version

Example: 

                    GET https://webservices1.autotask.net/atservicesrest/v1.0/Version

When you run the query, you'll receive a response that lists the major version, minor version, and build number. The response , as shown below.

                    {
    "majorVersion": "2021.1",
    "minorVersion": "0",
    "build": "17791"
}

Taken together, these values form the complete version number. The syntax is major.version.minorVersion.buildNumber. In the example above, the version number is 2021.1.0.17791.

Additional resources