---
title: "Get Study Leave Period Groups"
method: GET
path: "/StudyLeave/Periods/Groups"
tags: ["Studyleave"]
---

# Get Study Leave Period Groups

`GET /StudyLeave/Periods/Groups`

**Requires permission:** *StudyLeaveAdmin*

Retrieve a list of study leave period groups with filtering, sorting, and pagination.

## Query parameters

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

## Response `200`

Success - Success

- GetStudyLeavePeriodGroupsResponse
  - `studyLeavePeriodGroups` StudyLeavePeriodGroup[]
    - `studyLeavePeriodGroupId` string, guid
    - `name` string
    - `active` boolean
    - `studyLeavePeriods` StudyLeavePeriod[]
      - `studyLeavePeriodId` string, guid
      - `studyLeavePeriodGroupId` string, guid
      - `name` string
      - `description` string, nullable
      - `hasSubmissions` boolean
      - `syncToWeekendLeave` boolean
      - `studyLeavePeriodAccess` StudyLeavePeriodAccess[]
        - `studyLeavePeriodAccessId` string, guid
        - `studyLeavePeriodId` string, guid
        - `houseId` string, guid, nullable
        - `yearId` string, guid, nullable
        - `house` House
          - `houseId` string, guid
          - `misId` string, nullable
          - `inUse` boolean
          - `code` string, nullable
          - `name` string, nullable
          - `type` string, nullable
          - `day` boolean, nullable
          - `addressLine1` string, nullable
          - `addressLine2` string, nullable
          - `locality` string, nullable
          - `administrativeArea` string, nullable
          - `country` string, nullable
          - `postcode` string, nullable
          - `longLat` string, nullable
          - `whatThreeWords` string, nullable
          - `daytimeNumber` string, nullable
          - `lastUpdated` string, date-time, nullable
          - `updatedBy` string, nullable
          - `staff` HouseStaff[], nullable
            - `houseStaffId` string, guid
            - `houseId` string, guid
            - `houseCode` string, nullable
            - `staffUPI` string, guid, nullable
            - `role` string, nullable
            - `phoneNumber` string, nullable
            - `bookableInHouseTours` boolean
            - `updateInSync` boolean
            - `staff` StaffMember
              - …
        - `year` Year
          - `yearId` string, guid
          - `academicYearId` string, guid
          - `misId` string, nullable
          - `code` string, nullable
          - `name` string, nullable
          - `finalYear` boolean
          - `dfEYear` integer, nullable
          - `position` integer, nullable
          - `inUse` boolean
          - `lastUpdated` string, date-time, nullable
          - `students` Student[]
            - `studentId` string, guid
            - `academicYearId` string, guid
            - `misId` string, nullable
            - `externalId` string, nullable
            - `externalId2` string, nullable
            - `upi` string, guid, nullable
            - `upn` string, nullable
            - `code` string, nullable
            - `inUse` boolean
            - `email` string, nullable
            - `academicHouseId` string, guid, nullable
            - `boardingHouseId` string, guid, nullable
            - `yearGroup` string, nullable
            - `form` string, nullable
            - `pupilType` string, nullable
            - `startDate` string, date-time, nullable
            - `leaveDate` string, date-time, nullable
            - `dateOfBirth` string, date-time, nullable
            - `initials` string, nullable
            - `forename` string, nullable
            - `preferredName` string, nullable
            - `middleNames` string, nullable
            - `surname` string, nullable
            - `gender` string, nullable
            - `pronouns` string, nullable
            - `addressId` integer, nullable
            - `addressLine1` string, nullable
            - `addressLine2` string, nullable
            - `locality` string, nullable
            - `administrativeArea` string, nullable
            - `country` string, nullable
            - `postcode` string, nullable
            - `mobileNumber` string, nullable
            - `daytimeNumber` string, nullable
            - `eveningNumber` string, nullable
            - `nationality` string, nullable
            - `secondNationality` string, nullable
            - `lastUpdated` string, date-time, nullable
            - `updatedBy` string, nullable
            - `appAccess` boolean
            - `candidateNumber` integer, nullable
            - `nationalityDescription` string, nullable
            - `yearJoined` integer, nullable
            - `previousSchoolId` string, guid, nullable
            - `attendanceEntries` AttendanceEntry[], nullable
              - …
            - `photo` string, nullable
            - `canBeMasqueraded` boolean
            - `sendRecord` Sql02SendRecord
              - …
            - `ealRecord` Sql02EalRecord
              - …
            - `medicalRecord` MedicalSummary
              - …
            - `academicHouseObject` House
              - …
            - `boardingHouseObject` House
              - …
            - `formObject` Form
              - …
            - `yearObject` Year — recursive
            - `relations` Relationship[], nullable
              - …
            - `inverseRelations` Relationship[], nullable
              - …
            - `classes` Class[], nullable
              - …
            - `musicLessons` MusicLesson[], nullable
              - …
            - `previousSchool` OtherSchool
              - …
            - `userFields` UserField[], nullable
              - …
          - `updatedBy` string, nullable
  - `meta` Meta
    - `page` integer
    - `pageSize` integer
    - `total` integer

## Other responses

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

---

[API](https://skmtc.net/tonbridge/apis/tonbridge-app-api.md) · [All operations](https://skmtc.net/tonbridge/apis/tonbridge-app-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/tonbridge/tonbridge-app-api/versions/28344aa564b4/schema)