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 Account resource and the Get Many (getAll) operation, this node retrieves multiple account records from your Zoho CRM instance. You can filter, sort, and limit the results according to your needs.

Common scenarios:

  • Fetching all or a subset of accounts for reporting or synchronization.
  • Filtering accounts by approval status, conversion status, territory, or other criteria.
  • Retrieving only specific fields to optimize data transfer.
  • Sorting accounts by a chosen field in ascending or descending order.

Practical examples:

  • Syncing all approved accounts into another system.
  • Listing accounts from a specific territory for a sales dashboard.
  • Exporting only selected fields (e.g., Account Name, Email) for a marketing campaign.

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 the query (see below for details).

Options sub-properties:

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

Output

  • The output is an array of JSON objects, each representing an account record from Zoho CRM.
  • The structure of each object depends on the selected fields and options, but typically includes standard account properties such as id, Account_Name, and any additional fields requested via the "Fields" option.
  • No binary data is returned by this operation.

Example output:

[
  {
    "id": "1234567890",
    "Account_Name": "Acme Corporation",
    "Approved": true,
    "Converted": false,
    // ...other fields as specified in the "Fields" option
  },
  ...
]

Dependencies

  • External Service: Requires access to a Zoho CRM account.
  • API Credentials: Needs a valid Zoho OAuth2 API credential configured in n8n (zohoOAuth2Api).
  • n8n Configuration: Ensure that the Zoho CRM API credentials are set up in the n8n credentials section.

Troubleshooting

Common issues:

  • Invalid credentials: If the Zoho OAuth2 credentials are missing or incorrect, authentication will fail.
  • Insufficient permissions: The connected Zoho user must have permission to read account records.
  • API limits: Zoho CRM may enforce rate limits; excessive requests could result in errors.
  • Field selection errors: Specifying non-existent or restricted fields in the "Fields" option may cause errors.

Error messages and resolutions:

  • "Invalid OAuth token": Re-authenticate or refresh your Zoho OAuth2 credentials in n8n.
  • "Permission denied": Check the Zoho user's permissions for the Accounts module.
  • "Invalid field name": Review the "Fields" option and ensure all selected fields exist in your Zoho CRM schema.
  • "Request limit exceeded": Wait before retrying or reduce the frequency of your requests.

Links and References

Discussion