EVevolia
Public
Leaves

Get leave requests

get/v1/public/leaves

Request

  • Base URL
    https://api.evolia.com
  • Auth
    HTTP basic

Query parameters

fromDatestring required
Example:2021-01-31T20:00:00.000-05:00

a date in ISO-8601 format (2021-01-31T20:00:00.000-05:00). All resulting leaves will have an start date after this date.

toDatestring required
Example:2021-01-31T20:00:00.000-05:00

a date in ISO-8601 format (2021-01-31T20:00:00.000-05:00). All resulting leaves will have an end date before this date.

forTeamIdsstring[]

if specified, use this array of team UIDs to only get leaves linked to those teams

forTeamCodesstring[]

if specified, use this array of team codes to only get leaves linked to those teams

forMemberIdsstring[]

if specified, use this array of member UIDs or employee ids to only get leaves linked to those members

forLocationIdsstring[]

if specified, use this array of location UIDs to only get leaves linked to those locations

forLocationCodesstring[]

if specified, use this array of location codes to only get leaves linked to those locations

forSkillIdsstring[]

if specified, use this array of skill UIDs to only get leaves linked to those skills. A skill is a position in Evolia application but the API uses the skill term

forSkillCodesstring[]

if specified, use this array of skill codes to only get leaves linked to those skills. A skill is a position in Evolia application but the API uses the skill term

forStatusesstring[]

if specified, this is array of leave status used to get leaves having one of those statuses

forBankCodesstring[]

if specified, this is array of bank codes used to get leaves having one of those codes

includeRelationshipsboolean

if true, beside returning the leaves, the relationships property will includedata related to the leaves: members, skills, locations and teams

skipnumber

Paging attribute, Skips over the specified number of item.

takenumber

Paging attribute, limits the number of item to fetch.

Response

uidstring required

unique leave id

status'PENDING' | 'DECLINED' | 'APPROVED' | 'PAID' required

The approval status of the leave

bankIdstring required

The UID of the leave bank linked to this leave

bankNamestring required

The name of the leave bank linked to this leave

bankCodestring required

The code of the leave bank linked to this leave

memberIdstring required

The member (employee) UID linked to this leave

memberCodestring required

The member (employee) code linked to this leave

memberHourlyWagenumber

Contains the member hourly wage specific to the skill of the leave or the member base hourlyWage.

createdAtstring required

Leave creation date and time. In ISO-8601 format

createdByMemberIdstring required

The member (an employee or manager) UID who created this leave

createdByMemberCodestring required

The member (an employee or manager) code who created this leave

fromstring required

The starting date of the leave. In ISO-8601 format.

tostring required

The ending date of the leave. In ISO-8601 format.

fromAllDayboolean required

When true the leave first day has no specific time range

toAllDayboolean required

When true the leave last day has no specific time range

hoursToWithdrawnumber required

The total number of hours to withdraw from the employee bank specified by bankName, bankCode and bankId

reasonstring required

The reason of the leave

declineReasonstring required

The reason the manager declined the leave

timeZonestring required

The leave time zone.

assignedManagerIdstring required

The member (a manager) UID who must approve this leave

assignedManagerCodestring required

The member (a manager) code who must approve this leave

bankedboolean required

When true the value is banked

bankedAtstring required

The date at which the hours have been banked. In ISO-8601 format.

teamIdstring

The team id linked to this leave

teamCodestring

The team code linked to this leave

skillIdstring

The skill (position) id linked to this leave

skillCodestring

The skill (position) code linked to this leave

locationIdstring

The location id linked to this leave

locationCodestring

The location code linked to this leave

Example response

[
  {
    "from": "2021-01-01T00:00:00.000-05:00",
    "to": "2021-01-02T00:00:00.000-05:00",
    "timeZone": "America/New_York",
    "bankedAt": "2021-01-02T00:00:00.000-05:00"
  }
]

Changes

No recorded changes to this operation across all 8 revisions of this API.