Zum Inhalt springen
Leadtime
Deutsch
Esc
navigateopen⌘Jpreview

Get vacation statistics

Returns comprehensive vacation statistics for the current employee for a specific year.

What is returned:

  • Vacation entitlement by contract
  • Days periods (when vacation days were added/deducted)
  • Pending vacation days (requests awaiting approval)
  • Approved future vacation days
  • Approved past vacation days (already taken)
  • Vacation days from overtime conversion
  • Added/deducted days (manual adjustments)
  • Total vacation days available
  • Total used vacation days
  • Total remaining vacation days
  • Potential vacation days (including pending requests)

Note: This endpoint is only available for employee accounts. If no year is provided in the query parameter, the current year is used.

GET/account/employee/vacations/stats
Authorization
AuthorizationOAuth2 access token · headerrequired
Scopes:api:read
or
AuthorizationBearer token (JWT) · headerrequired
Query parameters
yearnumber
Year for vacation stats
Responses
200
addednumber | nullrequired
approvedFutureVacationDaysnumberrequired
approvedPastVacationDaysnumberrequired
byContractnumberrequired
daysPeriodsVacationDaysPeriodDto[]required
Show properties
Array of VacationDaysPeriodDto
daysnumberrequired
fromstring<date-time>required
tostring<date-time>required
deductednumber | nullrequired
fromOvertimenumber | nullrequired
pendingVacationDaysnumberrequired
potentialVacationDaysnumber
totalRemainingVacationDaysnumberrequired
totalUsedVacationDaysnumberrequired
totalVacationDaysnumberrequired
yearnumberrequired
401Unauthorized - Invalid or missing authentication token
403Forbidden - Insufficient API scopes or permissions
404Employee not found
Request
curl -X GET "https://leadtime.app/api/public/account/employee/vacations/stats" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"
Response
{
  "added": 0,
  "approvedFutureVacationDays": 10,
  "approvedPastVacationDays": 8,
  "byContract": 25,
  "daysPeriods": [
    {
      "days": 25,
      "from": "2024-01-01T00:00:00.000Z",
      "to": "2024-12-31T23:59:59.999Z"
    }
  ],
  "deducted": 0,
  "fromOvertime": 2,
  "pendingVacationDays": 5,
  "potentialVacationDays": 3,
  "totalRemainingVacationDays": 19,
  "totalUsedVacationDays": 8,
  "totalVacationDays": 27,
  "year": 2024
}