Skip to main content

List time-off balances

GET 

/api/time-off-balances

Returns, for the given year, the vacation, leave and target hours of each active person as shown in the Time-off Manager: total (from the time-off target), used, planned, requested and remaining. All values are hours. Used hours are counted up to the Monday of the current week (excluded), planned and requested from that Monday on, so values change over time even when the target does not. People without a time-off target are returned with total 0 and a null time_off_target_id.

Required permissions:

  • time_off_manager.view: allows listing your own balance.
  • time_off_manager.view_other: allows listing everyone's balances.

Request​

Responses​

Returns the list of time-off balances.