Reads all Leaves

get

https://api.factorialhr.com/api/2026-10-01/resources/timeoff/leaves

Reads all Leaves

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

ids[]

array of strings

Return only the leaves with these ids.

ids[]

employee_ids[]

array of strings

Return only the leaves of these employees.

employee_ids[]

leave_type_id[]

array of strings

Return only the leaves of these leave types. Despite the singular name it takes a list.

leave_type_id[]

string

Return only the leaves that had already started by this date (start date on or before it). Usable on its own; pair it with from for a window.

from

string

Return only the leaves that had not finished before this date, meaning they end on or after it or have no end date at all. Usable on its own; pair it with to for a window.

only_active

boolean

Retrieve only active leaves

include_deleted_leaves

boolean

required

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

approved

boolean

Set to true for leaves that were approved, false for leaves that were rejected. Leave it unset for every leave whatever its decision. Combining approved: true with include_pending: true returns approved and still-pending leaves together.

include_pending

boolean

Set to true to include leaves still awaiting a decision. On its own it returns ONLY the pending ones; alongside approved: true it returns approved and pending together.

include_leave_type

boolean

Retrieve leave types

include_duration

boolean

Retrieve leave duration

include_duration_by_day

boolean

Retrieve the per-day breakdown of the leave's duration (duration_by_day_attributes)

type_is_workable

boolean

Set to true for leaves whose leave type counts as worked time, false for those that do not. Leave it unset to get both.

type_is_payable

boolean

Set to true for leaves whose leave type is paid, false for unpaid ones. Leave it unset to get both.

forced_finish_on

string

Caps the per-day duration walk at this date. For endless leaves (finish_on = nil) it pins the walk end; for closed leaves whose finish_on sits past this date it truncates the walk. Never extends a leave past its real finish_on. Must fall inside the read window (from/to or overlaps_range_from/overlaps_range_to).

Response

Language

Credentials

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK