Support Help

Get Records

You can use the getrecords method to fetch users data specified in the API request.
URL format to getrecords:

XML: https://support.zoho.com/api/xml/MODULE/getrecords?authtoken=AUTHTOKEN&portal=PORTALNAME& department=DEPARTMENTNAME
JSON: https://support.zoho.com/api/json/MODULE/getrecords?authtoken=AUTHTOKEN&portal=PORTALNAME& department=DEPARTMENTNAME

Note:

  • Replace MODULE with any one of this requests, solutions, accounts, contacts, contracts, products, tasks. Replace AUTHTOKEN, PORTALNAME, DEPARTMENTNAME with your authtoken, portal name and department name respectively.

Request Parameters:

Parameters Type Description
authtoken* String Encrypted alphanumeric string to authenticate your Zoho credentials
portal* String portal of your Zoho Support
department* String department of your Zoho Support
selectfields string module(field labels) i.e, Requests(SLA,Final Response Time,Case Owner)
fromindex integer Default value - 1
toindex integer Default value - 20
Maximum value - 200
myrecords boolean myrecords = true displays own record

Notes:

  • While retrieving data from your Zoho Support, user’s field-level security settings are applied. Hence to fetch all users data, use the user ID with highest role (Ex: CEO) and profile (Ex: Administrator).
  • fromindex and toindex are optional parameters. By default the fromindex is 1 and toindex is 20.
  • sortbyfield and sortorder are also optional parameters
  • The value for lastmodifiedtime parameter should be in yyyy-MM-dd HH:mm:ss format

Sample Request URL:

Example 1 .

https://support.zoho.com/api/xml/requests/getrecords?authtoken=AUTHTOKEN&portal=demosupport&department=demodepartment

Result:

<requests>
<row no="1">
<fl val="CASEID">11111222220010010</fl>
<fl val="Subject">Demo Request Online</fl>
<fl val="Department">demodepartment</fl>
<fl val="Contact Name">John</fl>
<fl val="Product Name">Customer Care</fl>
<fl val="Email">john@demo.com</fl>
<fl val="Phone">002200330044</fl>
</row>
<row no="2">
<fl val="CASEID">11111222220010010</fl>
<fl val="Subject">Not able to create task</fl>
<fl val="Department">demodepartment</fl>
<fl val="Contact Name">Peter</fl>
<fl val="Product Name">People Care</fl>
<fl val="Email">peter@demo123.com</fl>
<fl val="Phone">9888888888889</fl>
</row>
<row no="3">
<fl val="CASEID">2000000010010</fl>
<fl val="Subject">Welcome</fl>
<fl val="Department">General</fl>
<fl val="Contact Name">Amit Agarwal</fl>
<fl val="Product Name">CRM</fl>
<fl val="Email">amit@dummyemail.com</fl>
<fl val="Phone">00909090990</fl>
</row>
</requests>

Example 2 .

https://support.zoho.com/api/xml/requests/getrecords?authtoken=AUTHTOKEN&portal=demosupport&department=General&myrecords=true

Result:

<requests>
<row no="1">
<fl val="CASEID">2000000010010</fl>
<fl val="Subject">Welcome</fl>
<fl val="Department">General</fl>
<fl val="Contact Name">Amit Agarwal</fl>
<fl val="Product Name">CRM</fl>
<fl val="Email">amit@dummyemail.com</fl>
<fl val="Phone">00909090990</fl>
</row>
</requests>

Note:

  • Date & Time must be in yyyy-MM-dd HH:mm:ss format.

Top