- Overview
- Authentication
- Organization
- API Limits
- Forms API
- Cases API
- Timesheet API
- Onboarding API
- Announcements API
- Leave API
- Attendance API
- Compensation API
- GETFetch Components API
- GETFetch Components by ID API
- GETFetch Salary Components API
- GETFetch Packages API
- GETFetch Package by ID API
- GETFetch Package Components API
- GETFetch Currencies API
- GETFetch Currency by ID
- GETFetch Revisions API
- GETFetch Revisions by ERECNO API
- GETFetch Revision Letters by ERECNO API
- GETPreview Revision Letter by Revision ID API
- GETDownload Revision Letter by Revision ID API
- GETFetch My Compensation API
- GETFetch Reasons API
- GETFetch Settings API
- PUTCancel Revision API
- GETFetch Salary API
- GETFetch Single Employee Salary API
- POSTAdd Salary API
- PUTUpdate Salary API
- Compensation API Error Codes
- Record Count API
- LMS API
- Courses API
- Pre Learning Activities API
- Post Learning Activities API
- Course Action API
- Course Learner API
- Batch API
- Batch Scheduler API
- Batch Action API
- Module API
- File API
- Content API
- Link API
- Session API
- Offline Test API
- Online Test API
- Assignment API
- Settings API
- Trainer API
- Rooms API
- Categories API
- LMS Api Error Codes
- Files API
- View API
- Standalone Function
- Status Codes
- Error Codes API
- HTTP Request Methods
Get Compensatory Requests API
To get the list of compensatory-off request records.
Request URL:
https://people.zoho.com/people/api/v2/leavetracker/compensatory/records
Header
Authorization:Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf
Method
GET
Scope
ZOHOPEOPLE.leave.READ
Request Parameters
| Parameter Name | Values Allowed | Default Value | Description |
| from* | String | - | From date to be specified |
| to* | String | - | To date to be specified |
| employee | JSONArray | [] | Employee IDs of the employees whose requests are to be fetched |
| location | JSONArray | [] | Location IDs of the employees whose requests are to be fetched |
| department | JSONArray | [] | Department IDs of the employees whose requests are to be fetched |
| approvalStatus | JSONArray | [] | Allowed Values - APPROVED, PENDING, REJECTED, CANCELLED, CANCELPENDING |
| dataSelect | MINE|SUBS|DIRSUBS|MINE,SUBS|ALL | ALL | MINE - Fetches only mydata SUBS - Fetches all reportees under the employee DIRSUBS - Fetches only direct reportees under the employee MINE,SUBS - Fetches both mydata and all the reportees data ALL - Fetches all applicable data |
| bookingStatus | JSONArray | [] | Allowed Values - BOOKABLE, AVAILED, EXPIRED |
| sort | date, -date, expiry, -expiry, employee, -employee | - | Sort based on date/employee/expiry - should be appended in front for descending order |
| startIndex | Integer | 1 | Start Index of the record fetch |
| limit | Integer | 200 | Limit of comp off requests to be fetched |
Threshold Limit: 300 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/v2/leavetracker/compensatory/recordsSample Response
Copied{
"records": [
{
"date": "21-Sep-2024",
"approvalStatus": "PENDING",
"duration": 0.25,
"unit": "QUARTER_DAY",
"description": "",
"expiry": "31-Dec-2024",
"id": "100002000000499028",
"employee": {
"name": "Zenitsu Agatsuma",
"employeeId": "1",
"id": "100002000000031573"
},
"credited": 0.25,
"availed": 0
},
{
"date": "07-Sep-2024",
"approvalStatus": "APPROVED",
"duration": "09:00",
"unit": "HOURS",
"balance": "03:00",
"description": "",
"expiry": "31-Dec-2024",
"id": "100002000000450005",
"employee": {
"name": "Nezuko Kamado",
"employeeId": "13",
"id": "100002000000139001"
},
"credited": "09:00",
"availed": "06:00",
"status": "BOOKABLE"
},
{
"date": "22-Sep-2024",
"approvalStatus": "",
"duration": 0.5,
"unit": "HALF_DAY",
"balance": 0.5,
"description": "",
"expiry": "30-Sep-2024",
"id": "100002000000481300",
"employee": {
"name": "Nezuko Kamado",
"employeeId": "13",
"id": "100002000000139001"
},
"credited": 0.5,
"availed": 0,
"status": "BOOKABLE"
},
{
"date": "28-Sep-2024",
"approvalStatus": "",
"duration": 1,
"unit": "FULL_DAY",
"balance": 1,
"description": "",
"expiry": "31-Dec-2024",
"id": "100002000000481534",
"employee": {
"name": "Nezuko Kamado",
"employeeId": "13",
"id": "100002000000139001"
},
"credited": 1,
"availed": 0,
"status": "BOOKABLE"
}
]
}© 2025, Zoho Corporation Pvt. Ltd. All Rights Reserved.