Search Records
zoho_crm.search_records
ActionCRM & salesconnection required
Calls the Zoho CRM API with the connection's credentials.
Search one Zoho CRM module by criteria expression, email address, phone number or free-text word, and return the matching page of records.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- OAuth 2.0
- Providers
- Zoho CRM
- Secret shape
- {"client_id": "…", "client_secret": "…", "refresh_token": "…"}
- Config it needs
- data_center, api_domain, accounts_url, api_version
- Resolved by
- config.connection_id, else node.connection_id
Configuration
10 fields, 1 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
module API name of the module to act on, such as Leads, Contacts, Accounts, Deals, Tasks, Products, Vendors or Invoices. A custom module's API name works too. | string | Yes | — | — | Leads |
criteria A Zoho criteria expression such as ((Last_Name:equals:Doe)and(Company:starts_with:Ac)). | string | No | — | — | (Last_Name:equals:Doe) |
email Search every email field in the module for this address. | string | No | — | — | — |
phone Search every phone field in the module for this number. | string | No | — | — | — |
word Search the whole module for this word. | string | No | — | — | — |
fields Comma-separated field API names to return, at most 50 of them. | string | No | — | — | Last_Name,Email,Company |
page Which page of results to return; the first page is 1. | number | No | 1 | ≥ 1 | — |
per_page How many records to return per page; Zoho allows at most 200. | number | No | 200 | 1–200 | — |
converted For Leads, whether to search converted leads, unconverted ones, or both. Zoho defaults to false. | string | No | — | one of "true", "false", "both" | — |
approved Whether to search approved records, unapproved ones, or both. Zoho defaults to true. | string | No | — | one of "true", "false", "both" | — |
- At least one of criteria, email, phone, word must be set.
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"criteria": "(Last_Name:equals:Doe)",
"fields": "Last_Name,Email,Company",
"module": "Leads",
"page": 1,
"per_page": 200
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
module The module API name the records were read from. | string | — |
records The records on this page, exactly as Zoho returned them. | array | — |
count How many records this page contains. | number | — |
page Which page number this is. | number | — |
per_page The page size Zoho applied. | number | — |
more_records True when another page of results is waiting. | boolean | — |
next_page_token Token for the next page beyond the 2,000-record mark. | string | — |
info Zoho's raw paging block, for anything not lifted out above. | object | — |
{
"count": 0,
"info": {},
"module": "",
"more_records": false,
"next_page_token": "",
"page": 0,
"per_page": 0,
"records": []
}Notes
- Zoho takes one search term per call and ignores the rest, so this node refuses a config that sets more than one.
- A search returns at most 2,000 records; narrow the criteria beyond that.
See Search Records run in a workflow.
In a technical demo we add the Zoho CRM connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.