Zoho Recruit icon

Zoho Recruit

Interact with Zoho Recruit API
Join our community

Actions25

Overview

This node interacts with the Zoho Recruit API to manage candidate records. Specifically, the "Candidate - Get Many" operation retrieves multiple candidate records from Zoho Recruit based on various filtering, sorting, and pagination options.

Common scenarios where this node is beneficial include:

  • Fetching a list of candidates for reporting or analysis.
  • Retrieving candidates filtered by approval or conversion status.
  • Exporting candidate data fields such as names, emails, or skills.
  • Integrating candidate data into other systems or workflows.

Practical example:

  • A recruiter wants to get all approved candidates sorted by last name to send them a bulk email campaign.
  • An HR system needs to import candidate details including their current employer and experience years for further processing.

Properties

Name Meaning
Return All Whether to return all matching candidate records or limit the number of results.
Limit Maximum number of candidate records to return if "Return All" is false.
Options Additional filters and controls:
  Fields Comma-separated list of candidate fields to retrieve (e.g., Last_Name,Email,First_Name).
  Sort By Field name to sort the results by (e.g., Email, Last_Name).
  Sort Order Sort direction: Ascending or Descending.
  Page Page number to retrieve (default is 1).
  Per Page Number of records per page (maximum 200).
  Converted Filter candidates by conversion status: All, Converted Only, or Non-Converted Only.
  Approved Filter candidates by approval status: All, Approved Only, or Not Approved Only.
  Custom View ID (cvid) Numeric ID of a custom view to filter records.
  Territory ID Numeric territory ID to filter records.
  Include Child Boolean indicating whether to include records from child territories.
  State Filter by record state: Draft or Save.

Output

The output is an array of JSON objects representing candidate records retrieved from Zoho Recruit. Each object contains the candidate's data fields as returned by the API, which can include standard and custom fields depending on the request.

If multiple pages are requested (when "Return All" is true), the node aggregates all pages into a single array.

No binary data is output for this operation.

Example output snippet (simplified):

[
  {
    "id": "123456789",
    "First_Name": "John",
    "Last_Name": "Doe",
    "Email": "john.doe@example.com",
    "Current_Employer": "Acme Corp",
    "Experience_in_Years": 5,
    ...
  },
  {
    "id": "987654321",
    "First_Name": "Jane",
    "Last_Name": "Smith",
    "Email": "jane.smith@example.com",
    "Current_Employer": "Globex Inc",
    "Experience_in_Years": 3,
    ...
  }
]

Dependencies

  • Requires an OAuth2 API credential configured for Zoho Recruit to authenticate requests.
  • The node uses the Zoho Recruit REST API endpoints, which vary by region (e.g., .com, .eu, .in).
  • No additional external dependencies beyond the n8n environment and the configured credentials.

Troubleshooting

  • Invalid or missing OAuth token: If authentication fails, re-authenticate the Zoho Recruit OAuth2 credentials in n8n.
  • API rate limits or quota exceeded: Zoho may limit API calls; consider adding delays or reducing the number of requests.
  • Invalid field names in "Fields" option: Ensure that the specified fields exist in Zoho Recruit; otherwise, the API may return errors or incomplete data.
  • Pagination issues: When "Return All" is enabled, the node fetches all pages automatically. If the API changes pagination behavior, some records might be missed.
  • Incorrect numeric IDs: For filters like Custom View ID or Territory ID, ensure numeric values are used.
  • Empty results: Check filter criteria and permissions in Zoho Recruit to confirm that matching records exist.

Links and References

Discussion