Data APIs
Zoho Desk provides a set of APIs that facilitate interaction between your extension and your help desk portal. The APIs available are listed below:
- Ticket Object
- Contact Object
- Account Object
- Current Call Object
- User Object
- Portal Object
- Department Object
- Extension Object
- Ticket Object
This object provides you with access to the various properties of a ticket. It is accessible only from the desk.ticket.detail.rightpanel, desk.ticket.detail.subtab and desk.ticket.detail.lefttab widget locations.
Request:
- ZOHODESK.get(“ticket”."<property>").then(function(response) {
- //Response - requested detail
- }).catch(function(err){
- //Error Handling
- })
Response:
- {
- "ticket"."<property>": "<Requested Value>",
- "status": "success"
- }
Contact Object
This object provides you with access to the various properties of a contact. It is accessible only from the contact detail page locations, and global widget locations.
Request:
- ZOHODESK.get("contact.<property>").then(function(response) {
- //Response - requested detail
- }).catch(function(err){
- //Error Handling
- })
Response:
- {
- "contact.<property>": "<Requested Value>",
- "status": "success"
- }
Account Object
This object provides you with access to the various properties of a account. It is accessible only from the account detail page locations, and global widget locations.
Request:
- ZOHODESK.get("account.<property>").then(function(response) {
- //Response - requested detail
- }).catch(function(err){
- //Error Handling
- })
Response:
- {
- "account.<property>": "<Requested Value>",
- "status": "success"
- }
Current Call Object
Listed below are the properties related to the user object:
Request:
- ZOHODESK.get("currentCall.<property>").then(function(response){
- // response requested-details
- }).catch(function(err){
- // Error Handling
- })
Response:
- {
- "currentCall.<property>": "<Requested Value>",
- "status": "success"
- }
User Object
Listed below are the properties related to the user object:
Request:
- ZOHODESK.get("user.<property>").then(function(response){
- // response requested-details
- }).catch(function(err){
- // Error Handling
- })
Response:
- {
- "user.<property>": "<Requested Value>",
- "status": "success"
- }
Portal Object
Listed below are the properties related to the portal object:
Request:
- ZOHODESK.get("portal.<property>").then(function(response){
- // response requested-detail
- }).catch(function(err){
- // Error Handling
- })
Response:
- {
- "portal.<property>": "<Requested Value>",
- "status": "success"
- }
Department Object
Listed below are the properties related to the department object:
Request:
- ZOHODESK.get("department.<property>").then(function(response){
- // response requested-detail
- }).catch(function(err){
- // Error Handling
- })
Response:
- {
- "department.<property>":"<Requested Value>",
- "status":"success"
- }
Zoho CRM Training Programs
Learn how to use the best tools for sales force automation and better customer engagement from Zoho's implementation specialists.
Zoho DataPrep Personalized Demo
If you'd like a personalized walk-through of our data preparation tool, please request a demo and we'll be happy to show you how to get the best out of Zoho DataPrep.
- Zoho Workerly Home
- Forums
- Connect With Us:
- Zoho Recruit Home
- Forums
- Connect With Us:
New to Zoho CRM Plus?
Deliver unforgettable customer experiences
New to Zoho CRM Plus?
Deliver unforgettable customer experiences
New to Zoho Marketing Plus?
Everything you need to run your marketing
New to Zoho Marketing Plus?
Everything you need to run your marketing
You are currently viewing the help pages of Qntrl’s earlier version. Click here to view our latest version—Qntrl 3.0's help articles.
New to Zoho Survey?
Zoho Sheet Resources
Zoho Forms Resources
New to Zoho Sign?
Zoho Sign Resources
Sign, Paperless!
New to Zoho TeamInbox?
Zoho TeamInbox Resources
New to Zoho ZeptoMail?
Zoho DataPrep Resources
Design. Discuss. Deliver.
New to Zoho Workerly?
New to Zoho Recruit?
New to Zoho CRM?
New to Zoho Projects?
New to Zoho Sprints?
New to Zoho Assist?
New to Bigin?
Related Articles
Data Storage APIs
Sometimes, the extensions you create might require data storage and retrieval capabilities. To help you in such cases, we provide a data store for extensions to set (store) and get (retrieve) data. The data can be deleted when it is no longer ...Event APIs
The following APIs help you incorporate custom functionalities in your extension when certain events occur in your help desk portal. Ticket Events You can configure extensions to receive information when an event, such as adding a comment to a ticket ...Extension APIs
These APIs fetch or set information related to the extension. Get extension config variable: Fetch the installation parameters of the extension. In production mode, only those parameters that have the value of the secure key set to false are ...Zoho Vertical Solutions APIs - An Overview
Zoho Vertical Solutions' APIs provide a developer-centric method to interact with and extend the capabilities of your Zoho Vertical Solution. These APIs are designed specifically for your solution orgs. This guide offers information on how to ...Invoke APIs
Below are some extra APIs that you can use in your extension. ROUTE_TO INSERT MODAL_CLOSE RESIZE ROUTE_TO This command navigates between the multiple subtabs on the ticket detail page. Listed below are the different routes supported: ...
New to Zoho LandingPage?
Zoho LandingPage Resources