Search Records
Purpose
To retrieve the records that match your search criteria.
Request Details
Request URL
{api-domain}/crm/{version}/{module_api_name}/search
Header
Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
Scope
scope=ZohoCRM.modules.{module_name}.{operation_type}
(and)
scope=ZohoSearch.securesearch.READ
Possible module names
leads, accounts, contacts, users, deals, campaigns, tasks, cases, events, calls, solutions, products, vendors, pricebooks, quotes, salesorders, purchaseorders, invoices, custom, notes, services, appointments, and appointments_rescheduled_history.
Possible operation types
ALL - Full access to the record
READ - Get records from the module
Request Details: criteria
| Request URL: | {api-domain}/crm/v3/{module_api_name}/search?criteria={criteria_here} |
Parameters
- criteriastring
- Performs search by following the shown criteria. (({api_name}:{operator}:{value})and/or({api_name}:{operator}:{value}))
- You can search for a maximum of 10 criteria (with same or different columns).
- The only operator that is supported for encrypted fields is equals.
- When you use "equals" in Search API, it behaves like contains and fetches the records accordingly. For example, if your condition is (Company:equals:ABC), the response will contain records with ABC as well as ABC Inc (i.e. they contain ABC) in their Company fields. For multiple conditions also, equals operator behaves like contains. For example, if your condition is ((Company:equals:ABC)and(First_Name:starts_with:M)), the response will contain records with first name starting with M and with ABC or ABC Inc in their Company fields.
- The "in" operator checks if a value is in a list. If you provide multiple values, the response includes records that match any of them.
For example, (Full_Name:in:Patricia,Boyle,Kate). - When a single-line field value contains characters such as "{", "}", "[", "]", "^", ":", "-", "/", "!", "?", "*", "_", "@", space, the Search API returns records with similar-looking values, even if the characters are not an exact match.
- For example, if Record A has the field value sales-team@zoho.com and Record B has sales_team@zoho.com, a search using equals:sales-team@zoho.com may return both records.
- When you use parentheses or comma in the value for a criteria, you must escape them using a backslash. Further, you must encode the value.
- Example:
Consider the search term: ((Last_Name:equals:Burns,B)and(First_Name:starts_with:M))
After escaping comma and parenthesis in the value: ((Last_Name:equals:Burns\,B)and(First_Name:starts_with:M))
After encoding the value: ((Last_Name:equals:Burns%5C%2CB)and(First_Name:starts_with:M))
- Example:
- When you use backslash as the last character in the value for a criteria, you must escape it using another backslash. Further, you must encode the value.
- Example:
Consider the search term: (Last_Name:equals:K\)
After escaping backslash in the value: (Last_Name:equals:K\\)
After encoding the value: (Last_Name:equals:K%5C%5C)
- Example:
- The supported data types are picklist, owner_lookup, user_lookup, lookup, phone, email, date, datetime, text, textarea, integer, currency, decimal, multiselectpicklist, bigint, percent, formula, website, boolean, and double.
- The supported operators are equals, starts_with, in, not_equal, greater_equal, greater_than, less_equal, less_than and between. Refer to the note section below to learn about the supported operator for each field type.
Note
The following section gives you the field types and the operators you can use in the "criteria" parameter
- Date, DateTime : equals, not_equal, greater_equal, greater_than, less_equal, less_than, between, in.
- Integer, Currency, Decimal : equals, not_equal, greater_equal, greater_than, less_equal, less_than, between, in.
- Boolean : equals, not_equal.
- textarea : equals, not_equal, starts_with.
- Lookup(user/owner) : equals, not_equal, in.
- Picklist, Autonumber : equals, not_equal, in.
- Text, Email, Phone, Website: equals, not_equal, starts_with, in.
- multiselectpicklist : equals, not_equal, in, starts_with.
- bigint: equals, not_equal, greater_than, greater_equal, less_than, less_equal, between, in.
- percent : equals, not_equal, greater_than, greater_equal, less_than, less_equal, between, in.
- formula: The supported operators of the formula datatype will depend on the return type of the formula. Please check the corresponding datatype's supported operators.
Sample Request to Search with criteria
Copied
In this example, the criteria for searching for the DateTime fields are in the ISO8601 format with the current user's time zone. The query is encoded.
Sample Response
Copied
Show full
Show less
Request Details: email
| Request URL: | https://www.zohoapis.com/crm/v3/{module_api_name}/search?email={email_here} |
Attributes
- emailstring
Performs module search by email. All the email fields of a particular module will be searched and listed.
Sample Request to Search by email
Copied
Sample Response
Copied
Show full
Show less
Request Details: phone
| Request URL: | https://www.zohoapis.com/crm/v3/{module_api_name}/search?phone={phone_number_here} |
Attributes
- phonestring
Performs module search by phone number. All the phone fields of a particular module will be searched and listed.
Sample Request to Search by Phone
Copied
Sample Response
Copied
Show full
Show less
Request Details: word
| Request URL: | https://www.zohoapis.com/crm/v3/{module_api_name}/search?word={search_word_here} |
Attributes
- wordstring
Performs global search by word.
Sample Request to Search by word
Copied
Sample Response
Copied
Show full
Show less
Other optional parameters
- fieldsstring
API names of the fields whose values you want to fetch in the response. You can include a maximum of 50 field API names in this parameter. Use the Fields MetaData API to get the API names of the fields in the module.
- convertedstring
To get the list of converted records. Default value is false.
- true - get only converted records
- false - get only non-converted records
- both - get all records
- approvedstring
To get the list of approved records. Default value is true.
- true - get only approved records
- false - get only records which are not approved
- both - get all records
- pageinteger
To get the list of records from the respective pages. Default value for page is 1.
- per_pageinteger
To get the list of records available per page. The default and the maximum possible value is 200.
- typestring
To get a specific user type from the Users module. Please note that this parameter is supported only for Users module.
The possible values are:
- AllUsers
- ActiveUsers
- DeactiveUsers
- ConfirmedUsers
- ConfirmedReportingUsers
- NotConfirmedUsers
- DeletedUsers
- ActiveConfirmedUsers
- AdminUsers
- ActiveConfirmedAdmins
- CurrentUser
Sample Request: To Search with a Single Criterion
Copied
Sample Response
Copied
Show full
Show less
Note
- Only one of the mandatory parameters (criteria, email, phone, word) would work at one point of time. Furthermore, if two parameters are given simultaneously, preference will be given in the order criteria, email, phone, and word, and only one of them would work.
- The page and per_page parameter is used to fetch records according to their position in the CRM. Let's assume that the user has to fetch 400 records. The maximum number of records that one can get for an API call is 200. So, for records above the 200th position, they cannot be fetched. By changing the values of the page (1, 2) and per_page (200) parameters, the user can fetch all 400 records using 2 API calls.
- You can search for and fetch a maximum of 2000 records using this API. Exceeding this limit throws the "LIMIT_REACHED" error.
- The value of the fields with sensitive health data will be retrieved only when Restrict Data access through API option in the compliance settings is disabled. If the option is enabled, the value will be null. Refer to HIPAA compliance for more details.
- When you create or edit a record, and search for it immediately, you may face the 204 NO CONTENT error due to a delay in indexing. To fetch records without any delay, use the Query API.
- The "in" operator supports upto 100 values.
- The "full_name" field contains the concatenated values of the First Name and Last Name fields.
This is a read-only field available only in the Leads, Contacts, and Users modules.
Possible Errors
- EXPECTED_PARAM_MISSINGHTTP 400
mandatory param missing
Resolution: Specify any of the mandatory parameters (criteria/email/phone/word) in your request to search based on criteria. - LIMIT_REACHEDHTTP 400
Maximum response iteration limit reached
Resolution: The search records API returns only 2000 records in an API call. - INVALID_QUERYHTTP 400
invalid query formed
Resolution: The operators/field API names in your search query are invalid, the value passed does not match the expected data type of the search field, there is a special character in the search value, or the field specified is not available in the search module. Refer to the "details" JSON object in the response to know which value is incorrect. - INVALID_DATAHTTP 400
The search value contains special characters or does not contain at least two characters
Resolution: Specify at least two characters in the search value and do not input special characters. - NOT_SUPPORTEDHTTP 400
module not supported for search
Resolution: The module you have specified is not supported for search operation. Refer to possible modules section above and specify a valid module API name. - INVALID_URL_PATTERNHTTP 404
Please check if the URL trying to access is a correct one
Resolution: The request URL specified is incorrect. Specify a valid request URL. Refer to request URL section above. - OAUTH_SCOPE_MISMATCHHTTP 401
Unauthorized
Resolution: Client does not have ZohoSearch.securesearch.READ scope. Create a new client with valid scope. Refer to scope section above. - NO_PERMISSIONHTTP 403
Permission denied to read
Resolution: The user does not have permission to read records. Contact your system administrator. - INTERNAL_ERRORHTTP 500
Internal Server Error
Resolution: Unexpected and unhandled exception in the server. Contact support team. - INVALID_REQUEST_METHODHTTP 400
The http request method type is not a valid one
Resolution: You have specified an invalid HTTP method to access the API URL. Specify a valid request method. Refer to endpoints section above. - AUTHORIZATION_FAILEDHTTP 400
User does not have sufficient privilege to read module details.
Resolution: The user does not have the permission to retrieve module details. Contact your system administrator.
Sample Response
Copied
Sample Response
Copied
Show full
Show less