Purpose
You can use this method to search records by regular expressions of selected columns.
Important Note: Irrespective of Zoho CRM Edition, you can request only max. 250 API calls / day using this method.
Example
XML Format: http://crm.zoho.com/crm/private/xml/Leads/getSearchRecords?apikey=APIKEY&ticket=TICKET
Parameters:
- selectColumns = Module(optional columns) i.e, leads(Last Name,Website,Email) OR All
- searchCondition=(Created By|=|username)
For this method, selectColumns and searchCondition parameters are mandatory.
You can specify the following condition parameters:
- is OR =
- isn't OR <>
- contains(*srcString*)
- starts with(*srcString)
- ends with(srcString*)
- doesn't contain
- < OR is before
- > OR is after
- <=
- =>
More Examples
Use Case 1:
If you want to select Lead Name,Company,Email,Mobile,Website from Leads and Email should contain "@sample.com",Then the search api request should be as like below
http://crm.zoho.com/crm/private/xml/Leads/getSearchRecords?apikey=APIKEY&ticket=TICKET&selectColumns=Leads(Lead Name,Company,Email,Mobile,Website)&searchCond
ition=(Email|contains|*@sample.com*)
Use Case 2:
If you want to select Company,Email,Website from Leads and No of Employees should be greater than 100,Then the search api request should be as like below string
http://crm.zoho.com/crm/private/xml/Leads/getSearchRecords?apikey=APIKEY&ticket=TICKET&selectColumns=Leads(Company,Email,Website)&searchCondition=(No of Employees|>|100)
Use Case 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 like below string
http://crm.zoho.com/crm/private/xml/Leads/getSearchRecords?apikey=APIKEY&ticket=TICKET&selectColumns=Leads(Lead Name,Email)&searchCondition=(Company|starts with|*Zoho)
Other Methods
Existing Methods
New Methods (From Oct 22, 2009):
Related Topics
It's unclear how searchCondition should be formatted from the example above. Could you give a more concrete example using both parameters?
Hi reiher,
I have added some more use cases for the getSearchRecords method.Kindly refer the "More examples" section above and revert, if you still need any clarification.
Regards,
Senthamil
[Zoho CRM Team]