Get Compensatory Off Requests API

Get Compensatory Off Requests API - v3

To get the list of compensatory off request records.

Request URL:

https://people.zoho.com/people/api/v3/leave-tracker/compensatory

Scope:

ZOHOPEOPLE.leave.READ

Request Type:

GET

Request Parameters:

Parameter Name	Values allowed	Default value	Description
from_date	date	-	From date
to_date	date	-	To date
employee_zoho_Ids	JSONArray	[]	Array of employee erecnos
employee_department_ids	JSONArray	[]	Array of department Ids
employee_location_ids	JSONArray	[]	Array of location Ids
employee_status	JSONAArray	[]	Array with values ACTIVE_USERS\|ACTIVE_EMPLOYEE_PROFILES\|EX_EMPLOYEES\|LOGIN_DISABLED
approval_status	String (APPROVED\|PENDING\| REJECTED\|CANCELLED\| CANCEL_PENDING\|ALL)	ALL	Approval status of records
data_select	String (MINE\|SUBORDINATES\| DIRECT_SUBORDINATES\| MINE,SUBORDINATES\|ALL)	ALL	MINE - Fetches only my data SUBORDINATES - Fetches all reportees under the employee DIRECT_SUBORDINATES - Fetches only direct reportees under the employee MINE,SUBORDINATES - Fetches both my data and all the reportees data ALL - Fetches all applicable data
record_status	JSONArray (BOOKABLE\|AVAILED\|EXPIRED)	[]	Status of the compensatory request
offset	Integer	0	Start index of the record fetch
limit	Integer	-	Limit of record fetch
sort	String (worked_date, -worked_date, expiry_date, -expiry_date, employee, -employee)	-	Sort based on leave type/ employee/ from date/ to date - should be appended in front for descending order

Threshold Limit: 30 requests | Lock period: 5 minutes

Threshold Limit - Number of API calls allowed within a minute.
Lock Period - Wait time before consecutive API requests.

Sample Request:

Copiedhttps://people.zoho.com/api/v3/leave-tracker/compensatory

Sample Response:

Copied   {
       "data": [
           {
               "reason": "",
               "unit": "FULL_DAY",
               "leave_avail_info": {
                   "leave_balance": 3,
                   "leave_credited": 4,
                   "leave_availed": 1
               },
               "record_status": "BOOKABLE",
               "approval_status": "APPROVED",
               "expiry_date": "31-Dec-2025",
               "compensatory_id": "100002000000169001",
               "worked_day": {
                   "worked_date": "14-Sep-2025"
               },
               "employee": {
                   "zoho_id": "100002000000040456",
                   "name": "Dhivya Dharshini",
                   "id": "1"
               }
           },
           {
               "reason": "water",
               "unit": "HOURS",
               "leave_avail_info": {
                   "leave_credited": "06:00",
                   "leave_availed": "00:00"
               },
               "approval_status": "PENDING",
               "expiry_date": "31-Dec-2025",
               "compensatory_id": "100002000000172001",
               "worked_day": {
                   "worked_date": "07-Sep-2025"
               },
               "employee": {
                   "zoho_id": "100002000000040456",
                   "name": "Dhivya Dharshini",
                   "id": "1"
               }
           }
      ],
       "message": "Record(s) fetched successfully.",
       "status": "success"
   }