Create Leave Request for Employee

Submits a new leave request on behalf of an employee for a specific date range.

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

Supported Apps

Here are the list of apps that support this API.

Workday (workday)
Sage (sage-hris)
ADP Workforce Now (adp-workforcenow-hris)
Personio (personio)
BambooHR (bamboohr)
Zoho People (zoho-people)
Deel (deel)
Humaans (humaans)
Breathe (breatheHR)

Supported Request Fields:

  • employeeId - Required
  • from - Required
  • to - Required
  • unit - Required
  • leaveTypeId

Additional Metadata:

  • sicknessId - Required (when leaveTypeId is "sick")
  • half_day_am_pm - Required (when unit is "HOURS")

Supported Response Fields:

  • leaveRequestId

Remarks

When unit is HOURS, include metadata key half_day_am_pm with value am or pm. If leaveTypeId is sick, include sicknessId in metadata.

7shifts (7shifts)
Alexis HR (alexishr)
PayFit (payfit)
IRIS Cascade (iriscascade)
People HR (peopleHR)
PrismHR (prismhr)

Refer api specific guides -

PrismHR API Guide

Darwinbox (darwinbox)

You must pass the following fields in the metadata:

  • isHalfDay: "yes" or "no"
  • isFirstOrSecondHalf: '1' (first half leave) , '2' (second half leave)" - is a required field, when isHalfDay is 'yes'
  • isPaidOrUnpaid: "paid" or "unpaid"
  • revokeLeave: 'yes' (to revoke an existing leave), 'no' (to apply a new leave)
Hibob (hibob)
TimeTac (timetac)

Supported Request Fields:

  • employeeId - Required
  • leaveTypeId - Required
  • from - Required
  • to - Required
  • unit - Required
  • amount - Required

Additional Metadata:

  • Any key-value pairs can be passed in metadata and will be forwarded to the TimeTac API

Supported Response Fields:

  • leaveRequestId
HR Works (hr-works)

Supported Request Fields:

  • employeeId - Required
  • leaveTypeId - Required
  • from - Required
  • to - Required

Additional Metadata:

  • metadata.status - Required

  • Allowed values are substitutionRequested cancellationRequested cancelled changesRequested editingChanges deletionRequested editing substitutionRejected requested validatedOk validatedNotOk certificatePending electronicCertificatePending electronicCertificateAvailable electronicCertificateRequestSent electronicCertificateRequestFailed reported

  • metadata.type - Required

  • Allowed values are SICK ABSENT

  • Any key-value pairs can be passed in metadata and will be forwarded to the HR Works API

Sesame HR (sesamehr)

Supported Request Fields:

  • employeeId - Required
  • leaveTypeId - Required
  • from - Required
  • to - Required
  • unit

Additional Metadata:

  • Any custom field can be passed in metadata and will be included in the request body

Supported Response Fields:

  • leaveRequestId
WebWork (webwork)

Supported Request Fields:

  • employeeId
  • leaveTypeId
  • from - Required
  • to - Required
  • unit
  • reason

Additional Metadata:

  • hours_per_day
  • leave_period

Remarks
The leaveTypeId determines whether the request is HOURS-based or DAYS-based. Call the List All Leave Types API (set originData=true) and inspect the time_unit for that leaveTypeId. If it supports DAYS, include leave_period in metadata with values: 0: Full day, 1: 1st half, 2: 2nd half. If it supports HOURS, include hours_per_day in metadata. Webwork dosen't return leaveRequestId after creation of leave

Makeshift (makeshift)

Supported Request Fields:

  • employeeId - Required
  • leaveTypeId - Required
  • from - Required
  • to - Required
  • unit - Required

Additional Metadata:

  • Any key-value pairs can be passed in metadata object

Supported Response Fields:

  • leaveRequestId

Remarks
Users can request multiple full days (when unit is DAYS) or a partial day (when unit is HOURS). Makeshift returns multiple leaveIds concatenated with '||'.

Body Params
string
required
string
required
date-time
required
date-time
required
string
enum
required
Allowed:
double
required
json
Responses

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