- Overview
- What's New in V8?
- Changelog
- Open API Specification 3.0.0 (OAS)
- API Directory
- API Collection
- APIs and References
- OAuth
- API Limits and Credits
- Compliance
- Zoho CRM SDKs
- Metadata APIs
- Customization
- Process Automation
- Security control
- Roles
- Profiles
- Territories
- GETTerritories
- POSTTerritories
- PUTTerritories
- DELETETerritories
- POSTTransfer and Delete Territories
- GETChild Territories of a Territory
- GETTerritories Assigned
- GETAssociated User Count
- GETRetrieve User details Associated with a Territory
- PUTAssociate Users with Territory
- POSTRemove Territories of Records
- POSTAssign Territories to Records
- DELETEDisassociate Users from Territory
- Export Audit Log
- Portals
- Data Sharing
- Company Settings
- Zia
- Core APIs
- Records
- Merge Records
- Share Records
- Mail Merge
- Services
- Appointments
- Appointments Rescheduled History
- Fields Attachments
- Meeting Cancel
- Notes
- Mass Actions
- Related Records
- External ID
- Emails
- Subforms
- Linking Modules
- Others
- Bulk APIs
- Composite API
- Query API
- Notification APIs
Search Records Using External ID
Purpose
To retrieve the records that match your search criteria using external fields.
Request Details
Request URL
https://www.zohoapis.com/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, Appointments, Services and Activities
Header
Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
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, appointments, services 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
Copiedcurl "https://www.zohoapis.com/crm/v8/Contacts/search?criteria=(External_Contact_ID:in:usercontact2,usercontact123)&fields=External_Contact_ID,Email"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-H "X-EXTERNAL: Contacts.External_Contact_ID"Sample Response
Copied{
"data": [
{
"Email": "crm@external1.com",
"External_Contact_ID": "usercontact123",
"id": "111111000000146004"
},
{
"Email": "crm@external.com",
"External_Contact_ID": "usercontact2",
"id": "111111000000101018"
}
],
"info": {
"per_page": 200,
"count": 2,
"page": 1,
"more_records": false
}
}Using the external value and the "equals" operator in "criteria"
Parameter:criteria=(External_Contact_ID:equals:usercontact123)
Sample Request
Copiedcurl "https://www.zohoapis.com/crm/v8/Contacts/search?criteria=(External_Contact_ID:equals:usercontact2)&fields=External_Contact_ID,Email"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-H "X-EXTERNAL: Contacts.External_Contact_ID"Sample Response
Copied{
"data": [
{
"Email": "crm@external1.com",
"External_Contact_ID": "usercontact123",
"id": "111111000000146004"
}
],
"info": {
"per_page": 200,
"count": 1,
"page": 1,
"more_records": false
}
}© 2025, Zoho Corporation Pvt. Ltd. All Rights Reserved.