Zoho Recruit icon

Zoho Recruit

Interact with Zoho Recruit API

Actions25

Overview

This node interacts with the Zoho Recruit API to manage roles within a Zoho Recruit account. Specifically, the "Get Role" operation retrieves detailed information about a specific role by its unique ID. This is useful in scenarios where you need to fetch role details for user management, permissions auditing, or integration with other systems that require role metadata.

Practical examples include:

  • Fetching role details to display in an internal dashboard.
  • Synchronizing role information with another HR or identity management system.
  • Automating workflows based on role attributes retrieved from Zoho Recruit.

Properties

Name Meaning
Role ID The unique identifier of the role to retrieve from Zoho Recruit. This is a required string input.

Output

The output JSON contains the data returned by the Zoho Recruit API for the specified role. It typically includes all properties and metadata associated with that role, such as role name, description, permissions, and any other relevant fields defined by Zoho Recruit.

The output structure is an array of JSON objects representing the role data. Each item corresponds to one role record fetched (in this case, a single role).

Example output snippet (conceptual):

{
  "id": "1000000000001",
  "name": "Recruiter",
  "description": "Role responsible for managing candidates",
  "permissions": [...],
  ...
}

No binary data is involved in this operation.

Dependencies

  • Requires an active OAuth2 API credential for Zoho Recruit to authenticate requests.
  • The node uses the Zoho Recruit REST API endpoint, which varies depending on the region of the Zoho account (e.g., zoho.com, zoho.eu).
  • Proper configuration of the OAuth2 credentials in n8n is necessary to ensure successful API calls.

Troubleshooting

  • Missing or invalid Role ID: The Role ID must be provided and valid; otherwise, the API will return an error. Ensure the Role ID is correct and exists in your Zoho Recruit account.
  • Authentication errors: If the OAuth token is expired or invalid, the node will fail. Re-authenticate the Zoho Recruit credentials in n8n.
  • API endpoint issues: The node dynamically selects the API base URL based on the OAuth token's domain. If your Zoho Recruit instance is in a less common region, verify that the correct endpoint is used.
  • Network or permission errors: Ensure that the API user has sufficient permissions to access role data in Zoho Recruit.

Common error messages may include:

  • "Role ID is required for get role operation" — occurs if the Role ID property is empty.
  • HTTP 401 Unauthorized — indicates authentication failure.
  • HTTP 404 Not Found — indicates the specified Role ID does not exist.

Links and References

Discussion