---
title: "Get Leave Group Overview"
method: GET
path: "/LeaveRequests/Overview"
tags: ["Leaverequests"]
---

# Get Leave Group Overview

`GET /LeaveRequests/Overview`

**Requires permission:** *StaffMember*

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

## Query parameters

- `groupId` integer, nullable
- `year` integer, nullable
- `page` integer, required
- `pageSize` integer, required
- `includes` string[], nullable
- `sort` string, nullable
- `filter` string, nullable

## Response `200`

Success - Success

- GetLeaveGroupOverviewResponse
  - `groupName` string
  - `year` integer
  - `currentYear` integer
  - `memberCount` integer
  - `missingThisYear` integer
  - `missingNextYear` integer
  - `totalAllowance` number, double
  - `totalTaken` number, double
  - `totalRemaining` number, double
  - `expectedTakenByNow` number, double
  - `membersBehindPace` integer
  - `membersFullyUsed` integer
  - `pendingRequests` integer
  - `offToday` integer
  - `offThisWeek` integer
  - `daysBookedAhead` number, double
  - `toilAccrued` number, double
  - `toilTaken` number, double
  - `byMonth` LeaveMonthPoint[]
    - `month` string, date-time
    - `days` number, double
  - `byType` LeaveTypeBucket[]
    - `leaveType` string
    - `days` number, double
  - `members` LeaveMemberOverview[]
    - `email` string
    - `name` string
    - `hasTracker` boolean
    - `hasNextYear` boolean
    - `entitlement` number, double
    - `carriedOver` number, double
    - `allowance` number, double
    - `taken` number, double
    - `remaining` number, double
    - `expectedTakenByNow` number, double
    - `toilAccrued` number, double
    - `toilTaken` number, double
    - `pendingRequests` integer
  - `meta` Meta
    - `page` integer
    - `pageSize` integer
    - `total` integer

## Other responses

- `400` — An Error Occurred - Explain Error
- `401` — Unauthorized
- `403` — Forbidden

## Changes

- **2026-08-26** `fc6ef4ddc0ba` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/tonbridge/apis/tonbridge-app-api/changes/LeaveRequests/Overview/get.md)

---

[API](https://skmtc.dev/tonbridge/apis/tonbridge-app-api.md) · [All operations](https://skmtc.dev/tonbridge/apis/tonbridge-app-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/tonbridge/tonbridge-app-api/revisions/223cb0feedeb/schema)