List Leave Requests

This endpoint can be used to list all leave requests for all the employees in the company.

However, if you need to get the leave requests of a particular employee, you will need to include employee_code as part of the query parameters.

This endpoint can further be used to get leave requests based on the status. You can achieve this by passing status as part of the query parameters.

NOTE: When the status is set to ON LEAVE, the API will return only employees on leave. When the status is set to UPCOMING LEAVE, the API will return only employees that will be going on leave within the next 5 days. Lastly, when the status is set to ON LEAVE TODAY, the endpoint will return only employees on leave today.

Query Params
string
required

This is your company name

string
enum
Defaults to ON LEAVE

This field is only required when you need to get leave requests based on status. The field can either have a value of PENDING or ON LEAVE or UPCOMING LEAVE or ON LEAVE TODAY

Allowed:
string

This is only required if you need to fetch leave requests for a particular employee

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json