Leave Balance API

Returns the current leave balance for an employee across different leave types.

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

Refer to the Leave Balance data model

Please refer to the Leave Balance data model.

The response of the API would be a List of Leave Balance models for the given employeeId for the current year.

Supported Apps

Here are the list of apps that support this API.

Darwinbox (darwinbox)
GreytHR (greythr)
Zoho People (zoho-people)
Workday (workday)
Sage (sage-hris)
ADP Workforce Now (adp-workforcenow-hris)
Personio (personio)
BambooHR (bamboohr)
Paychex (paychex)
Remote (remote)
Deel (deel)
Paycor (paycor)
Ceredian Dayforce (ceridianDayforce)
Rippling (rippling)
UKG Pro (ukgpro-hris)
Keka HR (keka)
UKG Ready (ukgready)
WebWork (webwork)

Supported Request Fields:

  • employeeId - Required
  • originData

Additional Metadata:

  • No metadata parameters supported

Supported Response Fields:

  • balances
  • balances.leaveType
  • balances.leaveType.id
  • balances.leaveType.name
  • balances.leaveType.type
  • balances.unit
  • balances.balance
  • balances.used
Clockify (clockify)
Hibob (hibob)
Query Params
string
required

Employee ID

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