Holidays

For more details on how to work with holidays please refer to: Holidays Settings.
The Holiday entity represents a specific holiday that can be defined within the holiday calendar. One holiday calendar includes multiple holidays.
The primary function of the holiday entity is to define an employee's availability on a specific calendar date based on their defined cost rate (Salary entity).

You can find out more about how holidays affect availability and capacity in our Help article: Capacity vs. Availability: What You Need To Know

The following diagram shows holidays in our data hierarchy:

PersonHoliday CalendarSalariesHolidays

Attributes

after string
Parameter `filter`

Filter to return holidays on or after this date.
before string
Parameter `filter`

Filter to return holidays on or before this date.
creator person
Response

The person who created this holiday entry.
date string
Response Request

The date of this holiday.
holiday_calendar holiday calendar
Response

The holiday calendar this holiday belongs to.
holiday_calendar_id integer
Request Parameter `filter`

ID of the holiday calendar this holiday belongs to.
name string
Response Request

The name of this holiday (e.g. Christmas Day).
organization organization
Response

The organization this holiday belongs to.

Examples

Loading example

Operations

GET /api/v2/holidays
Get all holidays
POST /api/v2/holidays
Create a holiday
DELETE /api/v2/holidays/{id}
Deletes a holiday
GET /api/v2/holidays/{id}
Get a holiday
PATCH /api/v2/holidays/{id}
Update a holiday