HomeGuidesAPI ReferenceChangelogDiscussions
API Reference

Reads all Leaves

Reads all Leaves

Log in to see full request history
Query Params
ids[]
array of integers

The leave ids to retrieve

ids[]
employee_ids[]
array of integers

The employee ids to retrieve

employee_ids[]
leave_type_id[]
array of integers

The leave type id to retrieve

leave_type_id[]
string

Valid date following the format YYYY-MM-DD

string

Valid date following the format YYYY-MM-DD

boolean

Retrieve only active leaves

boolean

Retrieve approved leaves

boolean

Retrieve pending leaves

boolean
required

Retrieve leave types

boolean
required

Retrieve leave duration

boolean

Retrieve workable leaves

Response

Response body
array of objects
object
integer
required

Identifier of the Leave

integer
required

Company identifier of the employee of the leave

integer
required

Employee identifier of the leave

string
required

The start date of the leave

string

The end date of the leave

string

Indicates if the leave is taken as a half-day

string

A description of the leave

string

The reason provided by the employee for taking the leave

integer

The identifier for the type of leave

string

The name of the leave type

boolean

Indicates whether the leave has been approved

string

The full name of the employee taking the leave

string

The start time of the leave

integer

The total number of hours taken for the leave, represented in cents

string
required

The updated at date of the leave

string

The created at date of the leave

Language
Credentials
URL
Click Try It! to start a request and see the response here! Or choose an example:
application/json