CompanyCategories

This entity represents company (account) categories in Autotask. A company's category determines the layout of the entity's pages, which fields are visible, and which picklist options are available.

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: CompanyCategory

Entity Path:

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

If this entity has a Parent relationship, you must perform all Create, Update, and Delete actions on the parent entity. If this entity is a child of a parent, you can leverage our Swagger instance to find the URLs you should use in your API calls. For more information, refer to Finding resource and child access URLs of REST API entities. To learn how to access Swagger, refer to Using Swagger UI to explore REST API requests.

Parent None
Children None
URLs CompanyCategories/{id} (GET, PUT, PATCH)
CompanyCategories/query (GET, POST)
CompanyCategories/query/count (GET, POST)
CompanyCategories/entityInformation (GET)
CompanyCategories/entityInformation/fields (GET)

Conditions and requirements

General

  • On create of a company, if no CompanyCategory is passed in, the API will use the default category.

  • CompanyCategory default values will apply unless another value is passed in the API request.

  • It is not possible to create companies with inactive categories.

  • On Update, you cannot change a CompanyCategory to another category that is inactive.

  • While it is not possible to do so in the UI, you can use the API to create Companies with a CompanyCategory of 'API.'

Field definitions

The following table describes the standard Autotask fields for this entity. Refer to the following articles for more information about working with these fields:

To learn how to query picklist endpoints, refer to Understanding picklists.

Notes

  • For string datatypes, the number in parentheses ( ) indicates the maximum number of characters allowed.
  • LT indicates Local Term.
  • If this entity has child collections, they will appear in a Child collection access URLs or an Entity URLs and relationships drop-down in the Entity details section of this article.
  • You can call the /query/count/ endpoint of a resource to determine how many records a collection holds.
Field Name Datatype Read-Only Is Required Reference Name Picklist
displayColorRGB integer    
id long    
isActive boolean      
isApiOnly boolean        
isGlobalDefault boolean      
name string (30)      
nickname (3)        

Additional resources