Sign in
Leaverequests

Get Leave Group Overview

Requires permission: StaffMember

Admin-only figures for one leave group and leave year: tracker coverage, allowance used, activity and TOIL

get/LeaveRequests/Overview

Query parameters

groupIdinteger nullable
yearinteger nullable
pageinteger required
pageSizeinteger required
includesstring[] nullable
sortstring nullable
filterstring nullable

Response

Success - Success

groupNamestring
yearinteger
currentYearinteger
memberCountinteger
missingThisYearinteger
missingNextYearinteger
totalAllowancenumber double
totalTakennumber double
totalRemainingnumber double
expectedTakenByNownumber double
membersBehindPaceinteger
membersFullyUsedinteger
pendingRequestsinteger
offTodayinteger
offThisWeekinteger
daysBookedAheadnumber double
toilAccruednumber double
toilTakennumber double

Changes

Changed in 1 of the 22 revisions of this API.1