Fetch Records from Zoho Desk

Table of ContentsDown

Get Records

The zoho.support.getRecords() task is used to fetch records from any of the supported modules of Zoho Desk, into your Zoho Creator Application.

Supported Modules

  • Requests
  • Accounts
  • Contacts
  • Contracts

Syntax

<response> = zoho.support.getRecords(<moduleName>, <portal>, <department>, <fromIndex>, <toindex>);

where,
<response> is the reponse, of list:map() datatype, returned by Zoho Desk.
<moduleName>is the name of the Zoho Desk Module from where the record needs to be fetched. For example, "Requests" refers to the Requests module. The Zoho Desk modules that are supported by Creator are "Requests", "Accounts", "Contacts" and "Contracts".
<portal>is the name of the Zoho Desk Portal and <department> refers to the department in the portal from where the records need to be fetched. 
<fromIndex>(optional)- Default value - 1
<toIndex> (optional) Default Value- 20 

Note:

  • All the parameters listed above are mandatory, except the From Index and the To Index. If the parameters, From Index and the To Index are not used or only any one of them is used, in either case, only 20 records will be fetched by default. A maximum of 200 records can be fetched at once by using the From Index and To Index parameters. 

Example

response = zoho.support.getRecords("Requests", "zohotest", "database");          // fetches all the records
response = zoho.support.getRecords("Requests", "zohotest", "database", 3, 8);  // fetches all the records between indexes 3 and 8

where,
response is the reponse, of list:map() datatype, returned by Zoho Desk.
Requests is the name of the Zoho Desk Module from where the records need to be fetched.
zohotest is the name of the Zoho Desk Portal and database refers to the department in the portal where the records need to be fetched.
The numbers 3 and 8 denote the From index and the To index.

Response Format

The response returned by Zoho Desk will be in the format given below:

{
"Phone":"null",
"Subject":"null",
"Contact Name":"Max",
"CASEID":"60922000000055001",
"Request Id":"102",
"CONTACTID":"60922000000055002",
"DEP_ID":"60922000000006907",
"Email":"max@zillum.com",
"Ticket Id":"102",
"Department":"testing",
"Due Date":"null",
"URI":"/support/testing/ShowHomePage.do#Cases/dv/9042969c7524123f408f97465efbb15242acf79f93f757e8"
},
{
"Phone":"1 888 900 9646",
"Subject":"Welcome to Zoho Desk. You've got a sample Request!",
"Contact Name":"Lawrence",
"CASEID":"60922000000044038",
"Request Id":"101",
"CONTACTID":"60922000000044036",
"DEP_ID":"60922000000006907",
"Email":"support@zillum.com",
"Ticket Id":"101",
"Department":"testing",
"Due Date":"2014-04-23 07:47:00",
"URI":"/support/testing/ShowHomePage.do#Cases/dv/9042969c7524123f6b145cad551dccf983f3768859c3ef35"
}

If the execution fails due to incorrect parameter value,the response will be in the following format:

{"message":"Invalid User","code":"4861"