Leave Requests API

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
πŸ“˜

Refer to the Leave Requests data model

Please refer to the Leave Requests data model .

The response of the API is a List of Leave Requests for the given employeeId in the provided date range

πŸ“˜

Specify either the month or startDate and endDate

You have two options to pass the time range:

  • month: For example, 2022-05. It would fetch the list of leave requests for that month
  • startDate and endDate: It would fetch the list of leave requests within the range

Supported Apps

Here are the list of apps that support this API.

Darwinbox (darwinbox)
Keka HR (keka)
GreytHR (greythr)
Zoho People (zoho-people)
Workday (workday)
Sage (sage-hris)
ADP Workforce Now (adp-workforcenow-hris)
Personio (personio)
BambooHR (bamboohr)
Charlie HR (charliehr)
Remote (remote)
Deel (deel)
Humaans (humaans)
Breathe (breatheHR)

Supported Request Fields:

  • employeeId - Required
  • from - Required
  • to - Required
  • originData

Additional Metadata:

  • No metadata parameters supported

Supported Response Fields:

  • requests
  • requests.id
  • requests.startDate
  • requests.endDate
  • requests.requestedOn
  • requests.note
  • requests.status
  • requests.leaveType
  • requests.leaveType.id
  • requests.leaveType.name
  • requests.leaveType.type
  • requests.unit
  • requests.isPaid
Ceredian Dayforce (ceridianDayforce)
Factorial (factorialhr)
Paycor (paycor)
Rippling (rippling)
UKG Pro (ukgpro-hris)
SAP SuccesFactors (successfactors)
Humi HR (humi-hr)
7shifts (7shifts)
Alexis HR (alexishr)
UKG Ready (ukgready)
IRIS Cascade (iriscascade)
People HR (peopleHR)
Hibob (hibob)
ZingHR (zinghr)
Hubstaff (hubstaff)
WebWork (webwork)

Supported Request Fields:

  • employeeId
  • month
  • startDate
  • endDate
  • originData

Additional Metadata:

  • No metadata parameters supported

Supported Response Fields:

  • requests
  • requests.id
  • requests.startDate
  • requests.endDate
  • requests.requestedOn
  • requests.note
  • requests.status
  • requests.leaveType
  • requests.leaveType.id
  • requests.leaveType.name
  • requests.leaveType.type
  • requests.unit
  • requests.amount
  • requests.isPaid
Timedoctor (timedoctor)
Clockify (clockify)
TimeTac (timetac)

Supported Request Fields:

  • employeeId - Required
  • month
  • startDate
  • endDate
  • originData

Supported Response Fields:

  • requests
  • requests.id
  • requests.startDate
  • requests.endDate
  • requests.requestedOn
  • requests.status
  • requests.leaveType
  • requests.leaveType.id
  • requests.leaveType.name
  • requests.leaveType.type
  • requests.unit
  • requests.amount
  • requests.note
  • requests.isPaid
  • originData
HR Works (hr-works)

The difference between startDate and endDate should be maximum of 365 days.

LuccaHR (luccahr)
Makeshift (makeshift)

Supported Request Fields:

  • employeeId
  • month
  • startDate
  • endDate
  • originData

Additional Metadata:

  • No metadata parameters supported

Supported Response Fields:

  • requests
  • requests.id
  • requests.startDate
  • requests.endDate
  • requests.requestedOn
  • requests.status
  • requests.leaveType
  • requests.leaveType.id
  • requests.leaveType.name
  • requests.leaveType.type
  • requests.unit
  • requests.amount
Shapes (shapes)

Supported Request Fields:

  • employeeId
  • startDate
  • endDate
  • month
  • originData

Supported Response Fields:

  • requests.id
  • requests.fromDate
  • requests.toDate
  • requests.explanation
  • requests.status
  • requests.leaveType.id
  • requests.leaveType.name
  • requests.leaveType.type
Sesame HR (sesamehr)

Supported Request Fields:

  • employeeId
  • month
  • startDate
  • endDate
  • originData

Supported Response Fields:

  • requests
  • requests.id
  • requests.startDate
  • requests.endDate
  • requests.requestedOn
  • requests.note
  • requests.status
  • requests.leaveType
  • requests.leaveType.id
  • requests.leaveType.name
  • requests.leaveType.type
  • requests.unit
  • requests.amount
  • requests.isPaid
  • originData

Query Params
string
required

Employee ID

string
Defaults to 2023-04

Month in yyyy-mm format

string
string
boolean
Defaults to false

If true, we will include origin API response in the return. Default value is false

Responses

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