Purpose
You can use the getMyRecords method to fetch data by the owner of the ticket specified in the API request.
Request URL
Request Parameters
| Parameter | Data Type | Description |
| ticket* | String | - |
| apikey* | String | - |
| selectColumns* | String | Module(optional columns) i.e, leads(Last Name,Website,Email) OR All |
| fromIndex | Integer | Default value: 1 |
| toIndex | Integer | Default value:20 Maximum value:200
|
| sortColumnString | String | You can select one of the fields in CRM in to sort the data. Ex: sortColumnString=Company Here, sorting of the data will happen based on the Company field
|
| sortOrderString | String | Sorting order: asc or desc If you use the sortColumnString parameter, by default data is sorted in ascending order.
|
| lastModifiedTime | yyyy-MM-dd HH:mm:ss | Default value: null If you specify the time, created/modified data will be fetched after the configured time.
|
newFormat*
| Integer (1 or 2)
| newFormat=1: To exclude fields with "null" values while fetching data from your CRM account. newFormat=2: To include fields with "null" values while fetching data from your CRM account. |
* - Mandatory parameter
Additional Notes
- While retrieving data from your Zoho CRM account, role-based security (Roles, Profiles, Field-level security and Data sharing rules) is applied. Hence to retrieve all data, use the user ID with highest role (Ex: CEO) and profile (Ex: Administrator). Also make sure all fields are enabled in Field-level security settings. For role-based security settings, see Security Administration while generating API Ticket.
- fromIndex and toIndex are optional parameters. By default the fromIndex is 1 and toIndex is 20.
- sortColumnString and sortOrderString are also optional parameters
- The value for lastModifiedTime parameter should be in yyyy-MM-dd HH:mm:ss format
- Date should be in MM/dd/yyyy format
Examples
To fetch leads data
http://crm.zoho.com/crm/private/xml/Leads/getMyRecords?newFormat=1&apikey=API key&ticket=Ticket
For fetching data from other modules, replace Leads with Accounts, Contacts, Potentials, etc.
To fetch more than 200 records
By default you can fetch 20 records per batch. However, by using the toIndex parameter you can fetch up to 200 Records per batch. If you want to fetch more than 200 records, follow the steps given below:
Iteration 1: fromIndex=1&toIndex=200
Iteration 2: fromIndex=201&toIndex=400
To fetch leads with “Company” name in the ascending order
sortColumnString=Company&sortOrderString=asc
To fetch leads with “Company” name in the descending order
sortColumnString=Company&sortOrderString=desc
! This page does not exists
! This page does not exists