searchRecords
Table of Contents
Purpose
You can use the searchRecords method to get the list of records that meet your search criteria.
Request URL
XML Format:
https://<APPDOMAIN>/crm/private/xml/Leads/searchRecords?criteria=(((Last Name:Steve)AND(Company:Zillum))OR(Lead Status:Contacted))
JSON Format:
https://<APPDOMAIN>/crm/private/json/Leads/searchRecords?criteria=(((Last Name:Steve)AND(Company:Zillum))OR(Lead Status:Contacted))
Auth Token
Auth Token is an encrypted alphanumeric string that is required to authenticate your CRM account credentials. A valid user's Authentication Token is necessary to access the API. When making an API request, send the authentication token in the Authorization header as shown below:
https://<APPDOMAIN>/crm/private/xml/Leads/searchRecords?criteria=(((Last Name:Steve)AND(Company:Zillum))OR(Lead Status:Contacted))
Header:
Authorization=1000XXXX65.1000XXXX44.caXXXXXXXXXXXX
(See Using Authentication Token )
Request Parameters
| Parameter | Data Type | Description |
| criteria* | string | Specify the search criteria as shown in the Request URL section. |
| 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 |
| 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 | 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">