CRM Help

searchRecords Method

 Purpose

You can use the searchRecords method to get the list of records that meet your search criteria.

 Request URL

XML Format:
https://crm.zoho.com/crm/private/xml/Leads/searchRecords?authtoken=Auth Token&scope=crmapi&criteria=(((Last Name:Steve)AND(Company:Zillum))OR(Lead Status:Contacted))

JSON Format:
https://crm.zoho.com/crm/private/json/Leads/searchRecords?authtoken=Auth Token&scope=crmapi&criteria=(((Last Name:Steve)AND(Company:Zillum))OR(Lead Status:Contacted))

 Request Parameters

ParameterData TypeDescription
authtoken*StringEncrypted alphanumeric string to authenticate your Zoho credentials. 
scope*StringSpecify the value as crmapi.
criteria*stringSpecify the search criteria as shown in the Request URL section.
selectColumnsStringModule(optional columns) i.e, Leads(Last Name,Website,Email) OR All
fromIndexIntegerDefault value - 1
toIndexIntegerDefault value - 20
Maximum range value - 200
[Maximum range value = toIndex - fromIndex]
lastModifiedTimeyyyy-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 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

Note:

  • You can trigger this method only 60 times per minute.
  • The maximum calls you can make per day is 10000. However, if your edition API count is less than 10000 then the org count will be applied while using this method.
  • You can use a maximum of 5 criteria (with same or different columns) with equals and startsWith conditions. Other operators are not supported in this method.
  • Refer the Release Notes  page to learn more about enhancements made in the API implementation.

 Sample Response

<response uri="/crm/private/xml/Leads/searchRecords">

<result>
<Leads>
<row no="1">
<FL val="LEADID">508020000000556003</FL>
<FL val="SMOWNERID">508020000000050003</FL>
<FL val="Lead Owner">
<![CDATA[ John Doe ]]>
</FL>
<FL val="Company">
<![CDATA[ Zillum ]]>
</FL>
<FL val="Last Name">
<![CDATA[ Steve ]]>
</FL>
<FL val="No of Employees">
<![CDATA[ 0 ]]>
</FL>
<FL val="Annual Revenue">
<![CDATA[ 0 ]]>
</FL>
<FL val="SMCREATORID">508020000000050003</FL>
<FL val="Created By">
<![CDATA[ John Doe ]]>
</FL>
<FL val="MODIFIEDBY">508020000000050003</FL>
<FL val="Modified By">
<![CDATA[ John Doe ]]>
</FL>
<FL val="Created Time">
<![CDATA[ 2013-06-26 10:37:48 ]]>
</FL>
<FL val="Modified Time">
<![CDATA[ 2013-06-26 10:37:48 ]]>
</FL>
<FL val="Email Opt Out">
<![CDATA[ false ]]>
</FL>
<FL val="Currency">
<![CDATA[ INR ]]>
</FL>
<FL val="Exchange Rate">
<![CDATA[ 1.000000000 ]]>
</FL>
<FL val="Last Activity Time">
<![CDATA[ 2013-06-26 10:37:48 ]]>
</FL>
</row>
</Leads>
</result>
</response>

Share this post : FacebookTwitter

Still can't find what you're looking for?

Write to us: support@zohocrm.com