Skip to main content
Use leaves when you need the current time away from work for a Worker, for example to power a calendar or schedule, or when you want to record already-approved time off directly through the API. Each leave keeps its own status and includes a summary of the request attached to it.

​
Attributes

​
string
Unique identifier for the leave object, for example lv_1HPCXADYAhh5k1NMU0r1WUqs.
​
string
Current status of the leave. One of requested, approved, declined, or cancelled.
​
string
Type of leave. One of paid_time_off, vacation, personal_time_off, public_holiday, sick_time_off, parental_leave, dependent_sick_leave, medical_leave, family_compassionate_leave, marriage_leave, bereavement, jury_duty, military_leave, working_time_reduction_rtt, or unpaid_time_off.
​
string
The ID of the worker this leave belongs to.
​
string
First day of the leave, formatted as an ISO 8601 date.
​
string
Last day of the leave, formatted as an ISO 8601 date.
​
number
Total number of leave days. This value can be fractional.
​
number
Total number of leave hours.
​
object
Dictionary of ISO 8601 dates to hours for each day in the leave, for example { "2026-04-14": 8, "2026-04-15": 8, "2026-04-16": 4 }.
​
string | null
Optional note submitted with the leave. Returns null when no note was provided.
​
object
Summary of the request attached to this leave.
​
string
ISO 8601 timestamp of when the leave was created.
​
string
ISO 8601 timestamp of the most recent update to the leave.