View List of categories API

This API is used to list categories that a user case raise query to

Request URL:

https://people.zoho.com/api/hrcases/listCategory?

Header:

Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxx9be93.9b8xxxxxxf

View List of categories API Example:

Success Response Format

{
   "response": {
      "result": [
         {
"isAgent": <Returns true if user is an agent>,
"categoryIcon": <Returns Icon display name of the category>,
"isEnabled": <Returns true if the category is enabled>,
"categoryShortDescription": <Returns short description of the category>,
"serviceId": <Returns ID of service from where this category is enabled else returns emtpy>,
            "applicableLocations": <Returns array of location IDs specifically where the user is an agent for. If empty and if user is agent, then user is agent for all locations>,
            "categoryName": <Returns category name>,
            "categoryId": <Category ID>
           }, ...
       ],
       "message": "Success",
       "uri": "/api/hrcases/listCategory",
       "status": 0
    }
}

 Threshold Limit:  30 requests | Lock period: 5 minutes

Threshold Limit - Number of API calls allowed within a minute.
Lock Period - Wait time before consecutive API requests.

Request

Copiedhttps://people.zoho.com/api/hrcases/listCategory?

Header

CopiedAuthorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxx9be93.9b8xxxxxxf

Response

Copied{
	"response": {
	"result": [
	{
	"isAgent": true,
	"categoryIcon": "Travel",
	"isEnabled": true,
	"categoryShortDescription": "Post your queries regarding transportation facilities provided by our organization",
	"serviceId": "",
	"applicableLocations": [],
	"categoryName": "Transport",
	"categoryId": "323150000000202001"
	}, ...
			],
	"message": "Success",
		"uri": "/api/hrcases/listCategory",
	"status": 0
	}
}