Leave Management API Documentation
The Leave Management API allows users to handle employee leave requests efficiently, providing endpoints for searching, applying, and updating leave records. Below is a detailed description of how to use the Search Leave and Upsert Leave APIs, along with the expected input parameters and response formats.
1. Search Leave API
Purpose
The Search Leave API is designed to allow users to retrieve leave applications for specific employees or based on various filter criteria, such as leave type, date range, or status. This helps organizations manage leave requests more effectively by quickly identifying pending, approved, or rejected leave applications.
Request Parameters
When searching for leave applications, the following parameters are required or optional to narrow the results:
Response Format: Upon successfully searching for leave applications, the API returns the following details about each leave request:
Use Case Example
A manager wants to review all pending leave requests from employee "1001" within the time frame of June 20, 2024, to August 28, 2024, for "General Leave". Using the Search Leave API with the above parameters will return all relevant leave requests awaiting approval during that period.
2. Upsert Leave API
Purpose
The Upsert Leave API is used to either submit a new leave application or update an existing one. This API helps streamline the leave application process, ensuring that employees and managers can quickly apply for and modify leave requests.
Request Parameters
When applying for or updating a leave application, use the following parameters to ensure proper handling:
Upon successfully submitting or updating a leave request, the API returns a confirmation with the following details:
Was this article helpful?
That’s Great!
Thank you for your feedback
Sorry! We couldn't be helpful
Thank you for your feedback
Feedback sent
We appreciate your effort and will try to fix the article