Zoho CRM Custom icon

Zoho CRM Custom

Consume Zoho CRM API

Overview

The Zoho CRM Custom node for n8n allows you to interact with the Zoho CRM API. Specifically, when using the Lead resource and the Get Many (getAll) operation, this node retrieves multiple lead records from your Zoho CRM account. You can filter, sort, and limit the results based on various criteria.

Common scenarios:

  • Fetching all or a subset of leads for reporting or further automation.
  • Filtering leads by approval status, conversion status, territory, or custom fields.
  • Integrating Zoho CRM lead data into other systems or workflows.

Practical examples:

  • Retrieve all approved leads for a sales dashboard.
  • Get up to 100 unconverted leads for a follow-up campaign.
  • Export leads from a specific territory to a spreadsheet.

Properties

Name Type Meaning
Return All Boolean Whether to return all results or only up to a given limit. If false, "Limit" is used.
Limit Number Maximum number of results to return (only shown if "Return All" is false).
Options Collection Additional filters and settings for retrieving leads. See below for details.

Options sub-properties:

Name Type Meaning
Approved Boolean Whether to retrieve only approved records. Defaults to true.
Converted Boolean Whether to retrieve only converted records. Defaults to false.
Fields MultiOptions Return only these fields (select from available lead fields).
Include Child Boolean Whether to retrieve only records from child territories.
Sort By Options Field to sort records by (select from available lead fields).
Sort Order Options Ascending or descending order ("asc" or "desc").
Territory ID String Retrieve only records from this territory.

Output

  • The output is an array of JSON objects, each representing a lead record from Zoho CRM.
  • Each object contains the fields as returned by the Zoho CRM API, which may include standard and custom lead fields depending on your selection in the "Fields" option.
  • If "Fields" is specified, only those fields will be present in each output object; otherwise, all default fields are included.

Example output:

[
  {
    "id": "1234567890",
    "Company": "Acme Corp",
    "Last_Name": "Doe",
    "Email": "jane.doe@example.com",
    "Approved": true,
    ...
  },
  ...
]

Note: The actual structure depends on your Zoho CRM configuration and selected fields.


Dependencies

  • External Service: Requires access to a Zoho CRM account.
  • Authentication: Needs valid Zoho OAuth2 credentials configured in n8n (zohoOAuth2Api).
  • n8n Configuration: Ensure the Zoho CRM credentials are set up in your n8n instance.

Troubleshooting

Common issues:

  • Invalid Credentials: If authentication fails, check your Zoho OAuth2 credentials in n8n.
  • API Limits: Zoho CRM may enforce rate limits; excessive requests could result in errors.
  • Field Selection Errors: Selecting non-existent or restricted fields in "Fields" may cause API errors.
  • Territory/Filter Mismatch: Using invalid territory IDs or incompatible filter combinations may yield no results or errors.

Error messages and resolutions:

  • "Invalid value passed for field": Check that all field names and values match your Zoho CRM schema.
  • "Unauthorized" or "Invalid client": Re-authenticate or update your Zoho OAuth2 credentials.
  • "No data found": Adjust your filters or ensure there are matching leads in Zoho CRM.

Links and References

Discussion