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. Each leave keeps its own status and includes a summary of the request attached to it.

​
Attributes

​
id
string
Unique identifier for the leave object, for example lv_1HPCXADYAhh5k1NMU0r1WUqs.
​
status
string
Current status of the leave. One of requested, approved, declined, or cancelled.
​
type
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.
​
worker
string
The ID of the worker this leave belongs to.
​
starts
string
First day of the leave, formatted as an ISO 8601 date.
​
ends
string
Last day of the leave, formatted as an ISO 8601 date.
​
days
number
Total number of leave days. This value can be fractional.
​
hours
number
Total number of leave hours.
​
schedule
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 }.
​
note
string | null
Optional note submitted with the leave. Returns null when no note was provided.
​
request
object
Summary of the request attached to this leave.
​
created
string
ISO 8601 timestamp of when the leave was created.
​
updated
string
ISO 8601 timestamp of the most recent update to the leave.
{
  "id": "lv_1HPCXADYAhh5k1NMU0r1WUqs",
  "status": "approved",
  "type": "vacation",
  "worker": "wr_CgcLakmx4guire",
  "starts": "2026-04-14",
  "ends": "2026-04-16",
  "days": 2.5,
  "hours": 20,
  "schedule": {
    "2026-04-14": 8,
    "2026-04-15": 8,
    "2026-04-16": 4
  },
  "note": "Annual vacation",
  "request": {
    "id": "lvr_6r3wLwX44s0Ak0bDkP5n2r7Q",
    "status": "approved",
    "created": "2026-03-10T18:42:11Z",
    "updated": "2026-03-11T09:05:52Z"
  },
  "created": "2026-03-10T18:42:11Z",
  "updated": "2026-03-11T09:05:52Z"
}