Zoho People icon

Zoho People

Consume Zoho People API

Overview

The Zoho People n8n node, when configured with the resource Attendance and operation Shift Details Of Employee, retrieves detailed shift configuration information for a specific employee within a given date range from the Zoho People API. This is useful for HR automation, reporting, or integration scenarios where you need to fetch an employee's shift schedule (such as start/end times, assigned shifts, etc.) programmatically.

Practical examples:

  • Automatically generating shift reports for payroll processing.
  • Integrating shift data into other HR or project management systems.
  • Sending notifications or reminders based on upcoming shifts.

Properties

Name Type Meaning
Employee Id String The unique identifier of the employee whose shift details are to be retrieved. Optional.
Email Id String The email address of the employee. Optional; not used in the actual API call here.
Map Id String An optional mapping identifier. Not used in the API call for this operation.
Start Date String The start date (YYYY-MM-DD) for the period to retrieve shift details. Required.
End Date String The end date (YYYY-MM-DD) for the period to retrieve shift details. Required.

Note: Only Employee Id, Start Date, and End Date are actually used in the API request for this operation.

Output

The output is a JSON object (or array of objects if multiple items are processed) containing the shift configuration details for the specified employee and date range. The exact structure depends on the Zoho People API response, but typically includes fields such as:

{
  "shiftDetails": [
    {
      "date": "2022-08-01",
      "shiftName": "Morning Shift",
      "startTime": "09:00",
      "endTime": "17:00",
      // ...other relevant fields
    },
    // ...more days
  ]
}
  • If the API returns an error and "Continue On Fail" is enabled, the output will include an error field with the error message.

Dependencies

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

Troubleshooting

Common Issues:

  • Missing or Invalid Credentials: If OAuth2 credentials are not set up correctly, authentication errors will occur.
  • Required Fields Missing: If Employee Id, Start Date, or End Date are missing or incorrectly formatted, the API may return an error.
  • API Limitations: If the date range is too large or the employee ID does not exist, the API may return empty results or errors.

Error Messages:

  • "Invalid EmpId": Ensure the Employee Id is correct and exists in Zoho People.
  • "Invalid Date Format": Dates must be in YYYY-MM-DD format.
  • "Unauthorized": Check your OAuth2 credentials and permissions.

How to resolve:

  • Double-check all input fields for correctness.
  • Ensure your Zoho People account has the necessary API access and permissions.
  • Review the error message in the output for more details.

Links and References

Discussion