Leave Request

{
  "id": "lvr_6r3wLwX44s0Ak0bDkP5n2r7Q",
  "status": "requested",
  "leave": {
    "id": "lv_1HPCXADYAhh5k1NMU0r1WUqs",
    "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"
  },
  "created": "2026-03-10T18:42:11Z",
  "updated": "2026-03-10T18:42:11Z"
}

Use leave requests when you need workflow details about submitted, approved, declined, or cancelled time-off requests. A worker can have more than one leave request for the same Leave over time.

Attributes

string

Unique identifier for the leave request, for example lvr_6r3wLwX44s0Ak0bDkP5n2r7Q.

string

Current request status. One of requested, approved, declined, or cancelled.

object

Summary of the leave attached to this request.

Show child attributes

string

The ID of the leave, for example lv_1HPCXADYAhh5k1NMU0r1WUqs.

string

Type of leave.

string

The ID of the worker the 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.

string

ISO 8601 timestamp of when the leave request was created.

string

ISO 8601 timestamp of the most recent update to this leave request.

{
  "id": "lvr_6r3wLwX44s0Ak0bDkP5n2r7Q",
  "status": "requested",
  "leave": {
    "id": "lv_1HPCXADYAhh5k1NMU0r1WUqs",
    "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"
  },
  "created": "2026-03-10T18:42:11Z",
  "updated": "2026-03-10T18:42:11Z"
}

Get a leave

Create a leave request

⌘I

Working with the API

Core Resources

HR

Workforce

Benefits

Payments

Payroll

Documents

Time

Labor

Legal

Attributes

​Attributes

Attributes