Search Records Using External ID
Purpose
To retrieve the records that match your search criteria using external fields.
Request Details
Request URL
{api-domain}/crm/{version}/{module_api_name}/search
Supported modules
Leads, Accounts, Contacts, Deals, Campaigns, Tasks, Cases, Events, Calls, Solutions, Products, Vendors, Price Books, Quotes, Sales Orders, Purchase Orders, Invoices, Custom, Notes, and Activities
Header
Authorization: Zoho-oauthtoken 100xx.92d4xxxxxxxxxxxxx15f52
X-EXTERNAL: {module_API_name}.{external_field_API_name}
Scope
scope=ZohoCRM.modules.all
(or)
scope=ZohoCRM.modules.{module_name}.{operation_type}
(and)
scope=ZohoSearch.securesearch.READ
Possible module names
leads, accounts, contacts, deals, campaigns, tasks, cases, events, calls, solutions, products, vendors, pricebooks, quotes, salesorders, purchaseorders, invoices, custom, notes and activities
Possible operation types
ALL - Full access to the record
READ - Get records from the module
Using the external value and the "in" operator in "criteria"
Parameter:criteria=(External_Contact_ID:in:usercontact2,usercontact123)
Sample Request
Copied
Sample Response
Copied
Using the external value and the "equals" operator in "criteria"
Parameter:criteria=(External_Contact_ID:equals:usercontact123)
Sample Request
Copied
Sample Response
Copied