Purpose
You can use the getRecords method to fetch all users data specified in the API request.
Request URL
- XML: http://crm.zoho.com/crm/private/xml/Leads/getRecords?newFormat=1&apikey=API Key&ticket=Ticket
- JSON: http://crm.zoho.com/crm/private/json/Leads/getRecords?newFormat=1&apikey=API Key&ticket=Ticket
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 | If you use the sortColumnString parameter, by default data is sorted in ascending order. |
| sortOrderString | String | Default value - asc
if you want to sort in descending order, then you have to pass sortOrderString=desc.
|
| lastModifiedTime | DateTime | Default value: null
If you specify the time, modified data will be fetched after the configured time. |
| newFormat* | Integer | newFormat=1: To exclude fields with "null" values while inserting data from your CRM account.
newFormat=2:To include fields with "null" values while inserting data from your CRM account. |
* - Mandatory parameter
Additional Notes
- While retrieving data from your Zoho CRM, 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.
- sortColumnString and sortOrderString are also optional parameters
- The value for lastModifiedTime parameter should be in yyyy-MM-dd HH:mm:ss format
Examples
To fetch all accounts in JSON format sorted by Account Name (in descending order) starting from 20 to 200
URL Format: http://crm.zoho.com/crm/private/json/Accounts/getRecords?newFormat=1&
apikey=sbdjEDBDJ1323&ticket=xy4gr112345fgg&fromIndex=20&toIndex=200&sortColumnString=Account Name&sortOrderString=desc
To fetch all accounts in XML format modified / created after 2008-05-27 00:00:00
URL Format: http://crm.zoho.com/crm/private/xml/Accounts/getRecords?newFormat=1&
apikey=sbdjEDBDJ1323&ticket=xy4gr112345fgg&lastModifiedTime=2008-05-27 00:00:00
! This page does not exists
! This page does not exists
Uploading ....