v1

latestOpenAPI 3.1.1LicenseRef-Proprietary2026-07-1310179223.1 KB

Time Off

Get All Allocations

List per-user time-off allocations (e.g. annual vacation balances).

get/allocations

Response

idnumber

startDatestring

endDatestring

contractStartDatestring

usernumber

timeOffTypenumber

daysnumber

daysCarriednumber

daysAllocatednumber

daysUsednumber

accrualFrequency'daily' | 'immediately'

restrictOverAllocationboolean

completedboolean

notesstring

createdBynumber

createdAtstring

Example response

[
  {
    "id": 876534,
    "startDate": "2019-01-01",
    "endDate": "2019-12-31",
    "contractStartDate": "2019-03-01",
    "user": 79786,
    "timeOffType": 16539,
    "days": 24,
    "daysCarried": 24,
    "daysAllocated": 6.2,
    "daysUsed": 8,
    "accrualFrequency": "daily",
    "notes": "some notes",
    "createdBy": 79562,
    "createdAt": "2018-06-01"
  }
]