List leave requests

get

https://app.peopleforce.io/api/public/v3/leave_requests

Returns a list of leave requests. The leave requests are reutrned sorted by the starting date of the leave request, with the most recent appearing last.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

employee_ids[]

integer

Return results filtered by these specified employee IDs. Multiple employe IDs can be provided using an ampersand separated list. For example, employee_ids[]=1&employee_ids[]=2

states[]

string

enum

Return results where states are filtered by these specified states. Multiple states can be provided using an ampersand separated list. For example, states[]=approved&states[]=pending

Allowed:

starts_on

date

Return results where leave requests start greater than or equal to this value.

ends_on

date

Return results where leave requests end less than or equal to this value.

page

integer

Defaults to 1

A cursor for pagination across multiple pages of results.

created_at[gt]

int64

Return results where the created_at field is greater than this value. Value should be a valid Unix timestamp.

created_at[lt]

int64

Return results where the created_at field is less than this value. Value should be a valid Unix timestamp.

updated_at[gt]

int64

Return results where the updated_at field is greater than this value. Value should be a valid Unix timestamp.

updated_at[lt]

int64

Return results where the updated_at field is less than this value. Value should be a valid Unix timestamp.

Response

Language

Credentials

Header

Loading…

Response

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

application/json

200OK