---
title: "Get leave banks"
method: GET
path: "/v1/public/leaves/banks"
tags: ["Public", "Leaves Bank"]
---

# Get leave banks

`GET /v1/public/leaves/banks`

## Request

- Base URL: `https://api.evolia.com`
- URL: `https://api.evolia.com/v1/public/leaves/banks`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/evolia/apis/public-evolia/docs/v1/public/leaves/banks/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieves a list of leave banks for the specified group

## Query parameters

- `includeRelationships` boolean

## Response `200`

- PublicLeaveBank[]
  - `uid` string, required: Unique leave bank id.
  - `names` object, required: The name of the bank in various locales. Accepted locales are en, fr, es.
  - `code` string: A human readable ID that can be use has an ID for other API calls. The code is also used to map a leave bank to an external system structural element.
  - `paid` boolean, required: if true, leaves for this bank is paid to the employee.
  - `unit` 'HOURS' | 'DAYS' | 'AMOUNT', required: The bank type of unit
  - `teamIds` string[]: An array of team UID indicating on which team the bank is applied to.
  - `teamCodes` string[]: An array of team code indicating on which team the bank is applied to.
  - `skillIds` string[]: An array of skill UID indicating on which skill (position) the bank is applied to.
  - `skillCodes` string[]: An array of skill code indicating on which skill (position) the bank is applied to.
  - `locationIds` string[]: An array of location UID indicating on which location the bank is applied to.
  - `locationCodes` string[]: An array of location code indicating on which location the bank is applied to.
  - `minimumDelayInDays` number: The minimum number of days required between a leave request submission and the leave's start date.
  - `blockNegativeBalanceCreation` boolean
  - `blockNegativeBalanceApprobation` boolean: When true, leave requests for this bank cannot be approved if the balance is negative.
  - `amountRequired` boolean: If true, leave requests submitted for this bank must specify an amount greater than zero.
  - `reasonRequired` boolean: If true, leave requests submitted for this bank must specify a reason.
  - `organizationalStructureRequired` boolean: If true, leave requests submitted for this bank must be associated to organizational structure elements (team, location, skill).
  - `excludeFromOvertime` boolean: If true, leave hours for this bank won't count towards overtime calculations.
  - `excludeFromHolidays` boolean: If true, leave hours for this bank won't count towards holiday calculations.
  - `excludeFromExperience` boolean: If true, leave hours for this bank won't count towards employee experience calculations.
  - `hideBank` boolean: If true, the bank balance is hidden from the employees' profile.
  - `workdayDurationInM` number: Only relevant when unit is PublicLeaveBankUnit.DAYS.Indicates the typical duration of a workday in minutes. For 8 hours the value is be 480
  - `exportToPayroll` boolean, required: If true, leave requests for this bank will be included in the timesheet report and exported to the payroll system.
  - `payrollExportHourlyWage` boolean: This property is only relevant if "exportToPayroll" is true. If true, exported leave requests for this bank will include hourly wage
  - `payrollEarningCode` string: This property is only relevant if "exportToPayroll" is true. If specified, exported leave requests for this bank will have this earning code. If not specified, the code property is used.
  - `payrollBankUnit` 'HOURS' | 'DAYS' | 'AMOUNT': This property is only relevant if "exportToPayroll" is true. The unit type of the leave bank balance in the payroll system. A conversion will occur if different from unit
  - `importBalances` boolean, required: If true, this bank's leave balances will be synchronized with data from the HR or payroll system.

## Changes

- **2026-09-25** `5f1c35aaddb3`: 1 info
  - added the optional property `items/excludeFromExperience` to the response with the `200` status

[Operation history](https://skmtc.dev/evolia/apis/public-evolia/changes/v1/public/leaves/banks/get.md)

---

[API](https://skmtc.dev/evolia/apis/public-evolia.md) - [All operations](https://skmtc.dev/evolia/apis/public-evolia/llms.txt) - [OpenAPI document](https://skmtc.dev/evolia/apis/public-evolia/revisions/e42abb18d4b6?raw)