---
title: "Find leave types"
method: GET
path: "/leave-types"
tags: ["leave-types"]
---

# Find leave types

`GET /leave-types`

## Request

- Base URL: `https://api.hoorayhr.io`
- URL: `https://api.hoorayhr.io/leave-types`
- Auth: API key in header `authorization`

Retrieves a list of all resources from the service.

## Response `200`

success

- LeaveTypes[]
  - `id` integer: ID of the leave type
  - `updatedBy` integer, nullable: ID user who updated item last
  - `name` string, required: Name of the leave type
  - `color` 'DARK_BLUE' | 'LIGHT_BLUE' | 'GREEN' | 'ORANGE' | 'YELLOW' | 'RED', required: Color of the leave type
  - `icon` 'PALMTREE' | 'LEAVE-GENERAL' | 'BACKPACK' | 'SUITCASE' | 'CLOCK' | 'PRAM' | 'PLANE' | 'CAR' | 'BIKE' | 'EDUCATION' | 'CERTIFICATE' | 'BOOK' | 'MISC' | 'REVIEW' | 'AGREEMENT' | 'ADDENDUM' | 'MUTATION' | 'USER' | 'TEAM' | 'PRESENT' | 'FLAG' | 'GOALS', required: Icon of the leave type
  - `budget` integer, required: Default budget for the leave type
  - `default` integer: Tiny-int indicating whether the leave type should be assigned automatically to new users
  - `calculationMethod` 'WORK_SCHEDULE' | 'INFINITE_BUDGET' | 'OVERTIME' | 'ONCE' | 'TIME_OFF_IN_LIEU' | 'RECURRING_FIXED_BUDGET', required: Enum describing the way the budget should be calculated
  - `periodOffset` integer: Amount of offset months the leave period should have. "0" starts with January. "5" starts with June. "11" starts with December.
  - `budgetReleaseRecurrence` 'YEARLY' | 'QUARTERLY' | 'MONTHLY' | 'WEEKLY': The time between recurring budget releases
  - `budgetReleaseTiming` 'LEAVE_PERIOD_START' | 'BUDGET_RELEASE_RECURRENCE_END': The moment the budget should be released
  - `accumulateBudgetWhenAbsent` string: Tiny-int indicating whether a correction should be applied when the user is on sick-leave. "0" a correction is applied. "1" a correction is NOT applied.
  - `overtimePercentage` integer: Percentage of overtime hours that should be provided as budget
  - `autoApproveLimit` integer: Maximum amount of minutes a leave request should have for automatic approval
  - `invisibleInCalendar` integer: Tiny-int indicating if the items should be invisible/anonymized in the calendar
  - `unpaidLeave` integer: Tiny-int indicating whether the time of leave should be marked as "unpaid"
  - `leaveInDays` integer: Tiny-int indicating if the budgets are defined in days instead of minutes
  - `leaveTypeSystemCategory` string: Enum describing a pre-defined leave type
  - `subtractHolidays` integer: Tiny-int indicating whether a correction for holidays should be applied
  - `useLeaveBudgetOnHoliday` integer: Tiny-int indicating whether a leave items should ignore holidays and deduct from the budget
  - `returnLeaveWhileSick` integer: Tiny-int indicating whether the hours you're sick during leave should be returned/compensated to your budget
  - `sendExpirationNotifications` integer: Tiny-int indicating whether expiration notifications should be sent for this leave type
  - `preventNegativeBudgetOnRequest` integer: Tiny-int indicating whether regular users can request leave that would result in a negative budget.
  - `isLegacy` integer: Tiny-int indicating whether the leave type is considered a legacy leave type
  - `archivedAt` string, date-time: Timestamp of leave type being archived
  - `createdAt` string, date-time: Creation date of the leave type
  - `updatedAt` string, date-time: Last updated date of the leave type

## Other responses

- `401`: not authenticated
- `500`: general error

---

[API](https://skmtc.dev/hoorayhr/apis/hoorayhr-api-documentation.md) · [All operations](https://skmtc.dev/hoorayhr/apis/hoorayhr-api-documentation/llms.txt) · [OpenAPI document](https://skmtc.dev/hoorayhr/apis/hoorayhr-api-documentation/revisions/3adcd47cd827?raw)