v1

latestOpenAPI 3.1.02026-07-26549156879.0 KB

Timeoff > Leave

Reads all Leaves

get/api/2026-07-01/resources/timeoff/leaves

Query parameters

ids[]string[]

The leave ids to retrieve

[
  "1"
]

employee_ids[]string[]

The employee ids to retrieve

[
  "1"
]

leave_type_id[]string[]

The leave type id to retrieve

[
  "36"
]

tostring

Valid date following the format YYYY-MM-DD

Example:2028-09-30

Valid date following the format YYYY-MM-DD

fromstring

Valid date following the format YYYY-MM-DD

Example:2028-09-01

Valid date following the format YYYY-MM-DD

only_activeboolean

Retrieve only active leaves

include_deleted_leavesboolean required

Whether to include deleted leaves (not included by default if not specified)

Example:true

Whether to include deleted leaves (not included by default if not specified)

approvedboolean

Retrieve approved leaves

Example:true

Retrieve approved leaves

include_pendingboolean

Retrieve pending leaves

Example:true

Retrieve pending leaves

include_leave_typeboolean

Retrieve leave types

include_durationboolean

Retrieve leave duration

Example:true

Retrieve leave duration

type_is_workableboolean

Retrieve workable leaves

type_is_payableboolean

Retrieve payable leaves

Response

Example response

{
  "data": [
    {
      "id": "1",
      "company_id": "1",
      "employee_id": "1",
      "start_on": "2028-09-05",
      "finish_on": "2028-09-05",
      "description": "Annual family vacation",
      "reason": "Medical appointment",
      "leave_type_id": "36",
      "approved": true,
      "employee_full_name": "Bob The Boss",
      "start_time": "09:00",
      "hours_amount_in_cents": 800,
      "updated_at": "2028-03-11T17:03:12.000Z",
      "created_at": "2028-03-11T17:03:12.000Z",
      "deleted_at": "2028-03-11T17:03:12.000Z",
      "days_taken": 1
    }
  ]
}