Zoho People icon

Zoho People

Consume Zoho People API

Leave → Get Leave Records V2

AI-generated

Summary

Fetch leave records within a specified date range filtered by various optional criteria such as approval status, employee identifiers, leave types, and data scope.

Inputs

  • From Date (required) — Start date for filtering leave records, formatted as specified in Date Format (default yyyy-MM-dd).
  • To Date (required) — End date for filtering leave records, formatted as specified in Date Format (default yyyy-MM-dd).
  • Approval Status (JSON Array) — Optional JSON array of approval statuses to filter by (APPROVED, PENDING, CANCELLED, REJECTED).
  • Data Select — Scope of leave records to fetch, e.g., ALL, MINE, SUBS, etc. Defaults to MINE.
  • Date Format — Format of the dates provided, default is yyyy-MM-dd.
  • Employee (JSON Array) — Optional JSON array of employee identifiers (Email ID, Employee ID, or Erec No) to filter leave records.
  • Leave Type (JSON Array) — Optional JSON array of leave type IDs to filter the records.
  • Limit — Maximum number of leave records to return, minimum 1, default 200.
  • Start Index — Index from which to start fetching records, default 0.

Output shape

a list of leave record objects matching the filter criteria

The output returns an array of leave record JSON objects. Pagination can be controlled using Limit and Start Index parameters. If an error occurs per item, it is included in the output if continueOnFail is enabled.

Discussion