Zoho Desk API

Number of APIs: 688

This is a Qodex collection covering the Zoho Desk API.

Disclaimer

• This collection is not by any means officially supported by Zoho Desk.
• Visit Zoho Desk Developer APIs forum for any API queries.
• Also refer official API documentation for more details.
  

Other Links

• File issue on github.
• Contribute to this collection.

---

Get Started

Get started by forking this collection.

Forking Qodex collection

• Fork this collection from the Zoho Desk [public workspace]

• Enter a name for your fork and select the workspace where it will be created.

• Similarly click on the Environments tab and fork the environment template.

• You should now see the Zoho Desk API collection and environment in your selected workspace.

• Update the environment variables with your secret keys and save.

• Set the environment to active.

You are now up and running with Zoho Desk API collections.

---

Conventions

1. All Zoho Desk APIs require Authorization fields in the header.
2. Always ignore undocumented fields or enum values present in the api response.These fields could be either experimental or deprecated.
3. Data fields in tickets, contacts, accounts, tasks etc are dynamic. This is due to security field filtering applied for user profile. Hence when coding with data from these api always consider them as dynamic.

Include

Zoho Desk enables you to retrieve different related resources through a single API request, which is made possible by the include query param. This query param takes a comma separated list of values corresponding to the API.

Compatibility

Backwards Compatibility on api changes is always maintained. Minor api changes like field, URL, query param deprecation will be notified via forum with a transition period. Support will be revoked after the end of transition period. Only major api interface change will involve the version number in the URL to change.

Pagination

In Zoho Desk, you can fetch multiple resources using listing APIs, such as list tickets , list agents and list departments and so on. The retrieval and arrangement of these resources on end-users' screen is called pagination. Pagination in listing APIs is made possible by two parameters: from and limit

The paginated responses are retrieved in the form of JSON objects that contain a key called data and a JSON array of resources (objects) as the value.

API Limits

Each Zoho Desk edition provides a default number of API calls. The default number is enforced daily and applies to the entire org irrespective of factors such as the number of IP addresses used to make the call. This limitation protects the service from overload while ensuring equitable resource sharing in the multitenant environment.

Maximum API limit in a 24-hour window for various edition of Zoho Desk

Note: The 24-hour window commences from 00:00 to 23:59:59 and follows the timezone of your data center.

Concurrency Limits

In addition to the above API limits, Zoho Desk also uses a Concurrency system to calculate API Limits based on the number of concurrent calls made per API client(used to generate OAuth token) per org in Zoho Desk. These concurrency limits specify the maximum number of API calls that can be simultaneously active at a given point of time per API client per org.

1. Agents - Delete unconfirmed agents POST {{baseUrl}}/api/v1/agents/deleteUnconfirmed

2. Roles - List agents by role GET {{baseUrl}}/api/v1/roles/:role_id/agents

3. Teams - Get team GET {{baseUrl}}/api/v1/teams/:team_id

4. Departments - Delete department logo DELETE {{baseUrl}}/api/v1/departments/:department_id/logo

5. Tickets - Execute Skill Based Assignment POST {{baseUrl}}/api/v1/tickets/:ticket_id/executeSkillbasedAssignment

6. Contacts - Get Contact GET {{baseUrl}}/api/v1/contacts/:contact_id

7. Tasks - Delete spam tasks POST {{baseUrl}}/api/v1/tasks/emptySpam

8. Products - Get product GET {{baseUrl}}/api/v1/products/:product_id

9. Labels - List labels GET {{baseUrl}}/api/v1/labels

10. Articles - List articles GET {{baseUrl}}/api/v1/articles