Modules
The Modules entity surfaces the availability and active status of modules (such as the Procurement module and the Inventory module) in Autotask.
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: | Modules |
Entity Path: |
/atservicesrest/v1.0/Modules |
Can Create: | |
Can Update: | |
Can Query: | |
Can Delete: | |
Can Have UDFs: |
Fields that cannot be queried
The following fields from this entity will return an error when queried.
- key
- value
Conditions and requirements
General
- This entity is unique. You can only query it.
Querying available modules
The purpose of this endpoint is to provide a mechanism for determining, via the API, if installed modules are available. You can use this insight to introduce logic-based workflows into your integrations. For example, your purchasing integrations could contact the Modules endpoint and check to see if provisioning is turned on. Based on the response received, your integration could then understand if it needed to behave differently and make decisions about when to use inventory-related API entities.
Query the Modules endpoint as follows:
https://webservices[n].autotask.net/atservicesrest/v1.0/Modules
Example:
GET https://webservices1.autotask.net/atservicesrest/v1.0/Modules
When you run the query, you'll receive a response that lists all of the modules installed in your Autotask database and their activation status. The query will return a response similar to the following example:
{
"modules": [
{
"key": 20,
"value": true
},
{
"key": 24,
"value": true
},
{
"key": 36,
"value": true
},
{
"key": 65,
"value": true
},
{
"key": 70,
"value": true
},
{
"key": 73,
"value": true
},
{
"key": 77,
"value": true
}
]
}
Each key shown corresponds to a module listed in the table below. The value field reports the activation status. True indicates enabled, while false represents disabled.
Module Name | Key |
---|---|
Change Management |
70 |
Document Management |
77 |
Inventory Module | 36 |
Multi-Currency setting | 73 |
Opportunities |
83 |
Outsource Management |
80 |
Procurement module | 65 |
Projects |
82 |
QuickBooks web connector |
76 |
Quote Management |
24 |
User Based Billing |
84 |