Zoho People icon

Zoho People

Consume Zoho People API

Overview

The Zoho People - Forms: Get Bulk Records operation retrieves multiple records from a specified Zoho People form in bulk. This node is useful for automating the extraction of large datasets from custom or standard forms within Zoho People, such as employee details, timesheets, or any other HR-related data stored in forms.

Common scenarios include:

  • Exporting all employee records for reporting or migration.
  • Fetching attendance logs or leave requests in bulk for analysis.
  • Integrating Zoho People form data with other systems (e.g., payroll, analytics).

Example:
You want to fetch 500 employee onboarding records starting from the 101st record for further processing in your workflow.


Properties

Name Type Meaning
Form Link Name String The unique link name identifier of the Zoho People form from which to fetch records.
Start Index Number The index of the first record to retrieve (for pagination; typically starts at 1).
Limit Number The maximum number of records to fetch in this request (batch size).
Search Column String (Optional) The column/field name to filter records by a specific value.
Search Value String (Optional) The value to search for in the specified search column.
Modified Time String (Optional) Filter records modified after this timestamp (format as required by API).

Output

The output is a JSON array where each element represents a single record from the specified form. The structure of each record depends on the fields defined in the Zoho People form you are querying.

General output structure:

[
  {
    "form_field_1": "value",
    "form_field_2": "value",
    "...": "...",
    // Additional fields as per the form definition
  },
  ...
]
  • If an error occurs and "Continue On Fail" is enabled, the output will include objects like:
{ "error": "Error message here" }

Note: This node does not output binary data.


Dependencies

  • External Service: Requires access to the Zoho People API.
  • Authentication: Needs valid Zoho People OAuth2 credentials configured in n8n (ZohoPeopleOAuth2Api).
  • Environment: No special environment variables required beyond n8n credential setup.

Troubleshooting

Common Issues:

  • Invalid Form Link Name: If the Form Link Name is incorrect, the API will return an error indicating the form was not found.
  • API Limits: Zoho People may restrict the number of records returned per request (Limit). Exceeding allowed limits may result in errors.
  • Authentication Errors: Expired or invalid OAuth2 tokens will cause authentication failures.
  • Incorrect Parameters: Supplying non-numeric values for Start Index or Limit will result in parameter validation errors.

Common Error Messages:

  • "Form not found": Check that the Form Link Name matches exactly with the form's link name in Zoho People.
  • "Invalid OAuth token": Re-authenticate or refresh your Zoho People credentials in n8n.
  • "Parameter missing or invalid": Ensure all required properties are filled and of the correct type.

Links and References


Discussion