Purpose
You can use this method to search records by expressions of the selected columns.
Request URL
XML Format: http://crm.zoho.com/crm/private/xml/Leads/getSearchRecords?apikey=API key&ticket=Ticket
Important Note: Irrespective of Zoho CRM Edition, you can send only 250 API requests / day. In each call you can fetch a maximum of 200 records.
Request Parameters
| Parameter | Data Type | Description |
| ticket* | String | - |
| apikey* | String | - |
| selectColumns* | String
| Module(optional columns) i.e, leads(Last Name,Website,Email) OR All |
| searchCondition* | String
| (Created By|=|username) |
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
Regular Expressions
While using this method, ensure selectColumns and searchCondition parameters are set as mandatory. You can specify the following expressions in API request:
- is OR =
- isn't OR <>
- contains(*srcString*)
- starts with(srcString*)
- ends with(*srcString)
- doesn't contain
- < OR is before
- > OR is after
- <=
- =>
Examples
Example 1
If you want to select Lead Name,Company,Email,Mobile,Website from Leads and Email should contain "@sample.com",Search API request should be as given below:
http://crm.zoho.com/crm/private/xml/Leads/getSearchRecords?apikey=API key&ticket=Ticket &newFormat=1&selectColumns=Leads(Lead Name,Company,Email,Mobile,Website)&searchCondition=(Email|contains|*@sample.com*)
Example 2
If you want to select Company,Email,Website from Leads and No of Employees should be greater than 100, Search API request should be as given below:
http://crm.zoho.com/crm/private/xml/Leads/getSearchRecords?apikey=API Key&ticket=Ticket&newFormat=1&selectColumns=Leads(Company,Email,Website)&searchCondition=(No of Employees|>|100)
Example 3
If you want to select Lead Name,Email from Leads and Company should start with "Zoho", then the search API request should be as given below:
http://crm.zoho.com/crm/private/xml/Leads/getSearchRecords?apikey=API key&ticket=Ticket&newFormat=1&selectColumns=Leads(Lead Name,Email)&searchCondition=(Company|starts with|Zoho*)
! This page does not exists
! This page does not exists
Uploading ....