n8n Zoho Creator Node

A robust and feature-complete n8n community node for Zoho Creator API v2.1 with automatic OAuth2 token refresh handling, multi-datacenter routing, cursor-based pagination, and binary file transfer support.

✨ Features

• Automatic Token Refresh: Uses OAuth2 with refresh tokens (zohoCreatorOAuth2Api) — seamless background authentication.
• Multi-Region Data Center Support: US (.com), EU (.eu), India (.in), Australia (.com.au), Japan (.jp), and China (.com.cn).
• Creator API v2.1 Architecture: Fully aligned with official Zoho Creator v2.1 endpoints and specifications.
• Comprehensive Resources & Operations:
  • Application:
    • Get Many: List all accessible Creator applications
  • Form:
    • Get Many: List all forms in an application
    • Get Fields: Fetch full field metadata for a form
  • Report:
    • Get Many: List all reports in an application
  • Record:
    • Create: Add a single record to a form
    • Create Many: Bulk insert records in batches of up to 200 per request
    • Get: Fetch a record by ID with field_config (all, quick_view, detail_view, custom)
    • Get Many: Query records with criteria and cursor-based pagination (record_cursor)
    • Update: Update a record by ID with field payloads and workflow triggers
    • Update Many: Update records in bulk matching criteria expressions
    • Delete: Delete a record by ID from a report
    • Delete Many: Delete records in bulk matching criteria expressions
    • Upload File: Upload attachments, photos, audio, video, or signatures to record fields
    • Download File: Download binary files or attachments from record fields
  • Raw / Custom API:
    • Execute arbitrary authenticated requests against Creator API endpoints with custom headers, query parameters, and payloads.

🔐 Authentication & Setup

This node uses a custom OAuth2 credential (zohoCreatorOAuth2Api).

Step 1: Create an OAuth App in Zoho API Console

1. Navigate to the Zoho API Console.
2. Click Add Client → Server-based Applications.
3. Set your Client Name, Homepage URL, and Authorized Redirect URI (e.g., https://your-n8n-instance/rest/oauth2-credential/callback).
4. Copy the Client ID and Client Secret.

Step 2: Configure Scopes

Default scopes provided by the credential:

ZohoCreator.dashboard.READ ZohoCreator.meta.application.READ ZohoCreator.meta.form.READ ZohoCreator.report.READ ZohoCreator.form.CREATE ZohoCreator.report.UPDATE ZohoCreator.report.DELETE ZohoCreator.bulk.CREATE ZohoCreator.bulk.READ

Additional scopes you may add depending on your needs:

• ZohoCreator.report.CREATE — Create reports
• ZohoCreator.meta.CREATE — Create applications or forms

Step 3: Configure Credential in n8n

1. In n8n, navigate to Credentials → New.
2. Select Zoho Creator OAuth2 API.
3. Choose your regional Authorization URL and matching Access Token URL:
   • US: https://accounts.zoho.com
   • EU: https://accounts.zoho.eu
   • India: https://accounts.zoho.in
   • Australia: https://accounts.zoho.com.au
   • Japan: https://accounts.zoho.jp
   • China: https://accounts.zoho.com.cn
4. Enter your Client ID and Client Secret.
5. Click Connect my account and approve access in the Zoho popup.

🚀 Usage Examples

1. Querying Records with Criteria & Custom Fields

• Resource: Record
• Operation: Get Many
• Account Owner Name: your_zoho_username
• Application Link Name: employee-management
• Report Link Name: All_Employees
• Field Config: Custom
• Custom Fields: First_Name,Last_Name,Email,Department
• Criteria: (Department == "Engineering" && Status == "Active")
• Return All: true (automatically handles cursor-based pagination)

2. Bulk Creating Records

• Resource: Record
• Operation: Create Many
• Account Owner Name: your_zoho_username
• Application Link Name: order-management
• Form Link Name: Orders
• Records Data (JSON Array):

  [
    {
      "Customer_Name": "Acme Corp",
      "Amount": 1250.00,
      "Order_Date": "10-Sep-2026"
    },
    {
      "Customer_Name": "Globex Inc",
      "Amount": 840.50,
      "Order_Date": "10-Sep-2026"
    }
  ]
  

3. Uploading an Attachment to a Record Field

• Resource: Record
• Operation: Upload File
• Account Owner Name: your_zoho_username
• Application Link Name: recruitment-tracker
• Report Link Name: Candidate_Profiles
• Record ID: 38700000012345678
• Field Name: Resume_Upload
• Binary Property: data

🛠️ Development & Testing

# Typecheck
npm run typecheck

# Scaffold and Registration Validation
npm run validate

# Unit Tests
npm run test

# Clean Build
npm run build

📦 Publishing

To publish to npm, run from your terminal:

cd /home/ryan/projects/n8n-nodes-zoho/creator && npm publish --access public

📄 License

MIT