List Records
zoho_crm.list_records
ActionCRM & salesconnection required
Calls the Zoho CRM API with the connection's credentials.
Read one page of records from a Zoho CRM module, with the field list, sort and custom view Zoho's Get Records endpoint accepts.
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, 2 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 |
fields Comma-separated field API names to return, at most 50. Zoho makes this mandatory when listing a module. | string | Yes | — | — | 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 | — |
sort_by Which field to sort the page by. Cannot be combined with cvid. | string | No | — | one of "id", "Created_Time", "Modified_Time" | — |
sort_order Sort direction for sort_by; Zoho defaults to descending. | string | No | — | one of "asc", "desc" | — |
cvid Id of a custom view to read instead of the whole module. | string | No | — | — | — |
converted For Leads, whether to return converted leads, unconverted ones, or both. Zoho defaults to false. | string | No | — | one of "true", "false", "both" | — |
ids Comma-separated record ids to restrict the page to. | string | No | — | — | — |
page_token Continue a listing past the 2,000-record mark: pass the next_page_token this node emitted for the previous page. Zoho ignores page while a token is set. | string | No | — | — | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"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 returns at most 200 records per page; page through more_records.
- page only reaches the first 2,000 records. Beyond that Zoho requires page_token, so feed next_page_token back into page_token.
See List 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.