- Overview
- What's New in V7?
- Changelog
- API Directory
- API Collection
- OAuth Authentication
- OAuth Scopes
- API Limits
- Multi DC Support
- Increase API Credits
- Customize API Usage Notification
- GDPR Compliance
- HIPAA Compliance
- API Dashboard
- HTTP Request Methods
- Status Codes
- Zoho CRM SDKs
- Metadata APIs
- Modules
- Fields
- Layouts
- Related Lists
- Profiles
- Custom View
- Roles
- Global Picklists
- 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
- Scoring Rules
- Variables
- Map Dependency
- Duplicate Check Option
- Data Enrichment
- Create Export Audit Log
- User Groups
- Tags
- Unsubscribe Links
- Cadences
- Pipeline
- Wizards
- Assignment Rules
- Templates
- User's Unavailability
- Portals
- Fiscal Year
- Business Hours
- Holidays
- Record Locking Configuration
- Shift Hours
- Entity APIs
- Organization
- Users
- Records
- Related Records
- Records APIs using External ID
- Related Records Using External ID
- Merge Records
- List of Available APIs
- Features
- Meeting Cancel
- Linking Modules
- Subforms
- Contact Roles
- Photos and Attachments
- Mass Update
- Mass Delete
- Currencies
- Files
- Share
- Fields Attachments
- Recycle Bin
- Change Owner
- Mass Change Owner
- Emails
- Blueprint
- Notes
- Bulk APIs
- Composite API
- Notification APIs
- Query API
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/v7/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/v7/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.