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

The leave ids to retrieve

ids[]

employee_ids[]

array of strings

The employee ids to retrieve

employee_ids[]

leave_type_id[]

array of strings

The leave type id to retrieve

leave_type_id[]

string

Valid date following the format YYYY-MM-DD

from

string

Valid date following the format YYYY-MM-DD

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

Retrieve approved leaves

include_pending

boolean

Retrieve pending leaves

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

Retrieve workable leaves

type_is_payable

boolean

Retrieve payable leaves

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