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

# Get Study Leave Options

`GET /StudyLeave/Options`

**Requires permission:** *StudyLeaveAdmin*

Get study leave options with filtering, sorting and paging

## Query parameters

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

## Response `200`

Success - Success

- GetStudyLeaveOptionsResponse
  - `studyLeaveOptions` StudyLeaveOption[]
    - `studyLeaveOptionId` string, guid
    - `studyLeaveOptionGroupId` string, guid
    - `name` string
    - `description` string, nullable
    - `code` string
    - `weekendLeaveOptionId` integer, nullable
    - `weekendLeaveOption` WeekendLeaveOption
      - `id` integer
      - `value` string, nullable
      - `requiresDescription` boolean
      - `requiresAddress` boolean
    - `studyLeaveOptionAccess` StudyLeaveOptionAccess[]
      - `studyLeaveOptionAccessId` string, guid
      - `studyLeaveOptionId` string, guid
      - `houseId` 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
            - `staffId` string, guid
            - `employeeId` string, nullable
            - `misId` string, nullable
            - `externalId` string, nullable
            - `externalId2` string, nullable
            - `hrId` string, nullable
            - `payrollId` string, nullable
            - `upi` string, guid, nullable
            - `code` string, nullable
            - `inUse` boolean
            - `email` string, nullable
            - `staffType` string, nullable
            - `school` string, nullable
            - `gender` string, nullable
            - `pronouns` string, nullable
            - `startDate` string, date-time, nullable
            - `leaveDate` string, date-time, nullable
            - `dateOfBirth` string, date-time, nullable
            - `initials` string, nullable
            - `title` string, nullable
            - `forename` string, nullable
            - `preferredName` string, nullable
            - `middleNames` string, nullable
            - `surname` string, nullable
            - `jobTitle` string, nullable
            - `mobileNumber` string, nullable
            - `internalNumber` string, nullable
            - `schoolNumber` string, nullable
            - `addressId` integer, nullable
            - `addressLine1` string, nullable
            - `addressLine2` string, nullable
            - `locality` string, nullable
            - `administrativeArea` string, nullable
            - `country` string, nullable
            - `postcode` string, nullable
            - `lastUpdated` string, date-time, nullable
            - `updatedBy` string, nullable
            - `appAccess` boolean
            - `photo` string, nullable
            - `canBeMasqueraded` boolean
            - `classes` Class[], nullable
              - …
            - `userFields` UserField[], nullable
              - …
      - `yearId` string, guid, nullable
      - `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
            - `attendanceEntryId` string, guid, nullable
            - `studentUpi` string, guid, nullable
            - `studentName` string, nullable
            - `student` Student — recursive
            - `lessonId` string, guid, nullable
            - `lesson` Lesson
              - …
            - `date` string, date-time
            - `attendanceCode` string, nullable
            - `submitted` string, date-time, nullable
            - `staffName` string, nullable
            - `staffUpi` string, guid, nullable
            - `staff` StaffMember
              - …
            - `archived` boolean
            - `periodId` string, guid, nullable
            - `periodNumber` integer, nullable
            - `period` Period
              - …
            - `classId` string, guid, nullable
            - `classCode` string, nullable
            - `class` Class
              - …
            - `subjectId` string, guid, nullable
            - `subjectCode` string, nullable
            - `subject` Subject
              - …
            - `houseId` string, guid, nullable
            - `house` House
              - …
            - `houseCode` string, nullable
            - `notes` string, nullable
            - `futureAbsenceId` string, guid, nullable
            - `absentAlertCounted` boolean
            - `attendanceCodeObject` AttendanceCode
              - …
            - `isAm` boolean
            - `isPm` boolean
            - `isRegistrationPeriod` boolean
          - `photo` string, nullable
          - `canBeMasqueraded` boolean
          - `sendRecord` Sql02SendRecord
            - `id` integer
            - `sendId` integer
            - `pupil_Name_Id` integer
            - `deleted` boolean, nullable
            - `priority` integer, nullable
            - `laptopUser` boolean, nullable
            - `access` string, nullable
            - `need` string, nullable
            - `youNeedTo` string, nullable
            - `mentor` boolean, nullable
            - `regular` boolean, nullable
            - `leadTeacher` string, nullable
            - `targets` string, nullable
          - `ealRecord` Sql02EalRecord
            - `id` integer
            - `ealId` integer
            - `pupil_Name_Id` integer
            - `deleted` boolean, nullable
            - `priority` integer, nullable
            - `access` string, nullable
            - `need` string, nullable
            - `youNeedTo` string, nullable
            - `leadTeacher` string, nullable
            - `listening` string, nullable
            - `reading` string, nullable
            - `writing` string, nullable
            - `speaking` string, nullable
            - `otherLanguages` string, nullable
            - `furtherComments` string, nullable
            - `pupil_Name_Id_String` string, nullable
          - `medicalRecord` MedicalSummary
            - `id` integer
            - `pupilMedicalId` integer
            - `nameId` integer, nullable
            - `medicalCondition` string, nullable
            - `medicalInformation` string, nullable
            - `allergy` string, nullable
            - `allergyInformation` string, nullable
            - `epiPen` string, nullable
            - `epiPenNotes` string, nullable
            - `inhaler` string, nullable
            - `inhalerNotes` string, nullable
          - `academicHouseObject` 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
              - …
          - `boardingHouseObject` 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
              - …
          - `formObject` Form
            - `formId` string, guid
            - `academicYearId` string, guid
            - `inUse` boolean
            - `misId` string, nullable
            - `code` string, nullable
            - `name` string, nullable
            - `year` string, nullable
            - `room` string, nullable
            - `lastUpdated` string, date-time, nullable
            - `updatedBy` string, nullable
            - `staff` StaffMember[], nullable
              - …
            - `students` Student[], nullable
          - `yearObject` Year — recursive
          - `relations` Relationship[], nullable
            - `relationshipId` string, guid
            - `fromUPI` string, guid, nullable
            - `toUPI` string, guid, nullable
            - `relationshipName` string, nullable
            - `rank` integer, nullable
            - `billing` boolean
            - `emergency` boolean
            - `medical` boolean
            - `courtOrder` boolean
            - `restricted` boolean
            - `relationshipType` string, nullable
            - `lastUpdated` string, date-time, nullable
            - `updatedBy` string, nullable
            - `createdByApp` boolean
            - `fromPerson` unknown
            - `toPerson` unknown
          - `inverseRelations` Relationship[], nullable
            - `relationshipId` string, guid
            - `fromUPI` string, guid, nullable
            - `toUPI` string, guid, nullable
            - `relationshipName` string, nullable
            - `rank` integer, nullable
            - `billing` boolean
            - `emergency` boolean
            - `medical` boolean
            - `courtOrder` boolean
            - `restricted` boolean
            - `relationshipType` string, nullable
            - `lastUpdated` string, date-time, nullable
            - `updatedBy` string, nullable
            - `createdByApp` boolean
            - `fromPerson` unknown
            - `toPerson` unknown
          - `classes` Class[], nullable
            - `classId` string, guid
            - `academicYearId` string, guid
            - `inUse` boolean
            - `misId` string, nullable
            - `code` string, nullable
            - `name` string, nullable
            - `subjectId` string, guid, nullable
            - `subject` string, nullable
            - `room` string, nullable
            - `yearGroup` string, nullable
            - `lastUpdated` string, date-time, nullable
            - `updatedBy` string, nullable
            - `classStaff` ClassStaff[], nullable
              - …
            - `students` ClassStudent[], nullable
              - …
          - `musicLessons` MusicLesson[], nullable
            - `id` integer
            - `studentNameId` integer
            - `studentUpi` string, guid, nullable
            - `teacherEmail` string, nullable
            - `instrumentId` integer
            - `lessons` integer
            - `created` string, date-time, nullable
            - `edited` string, date-time, nullable
            - `free` boolean, nullable
            - `notes` string, nullable
            - `archived` boolean
            - `instrument` MusicInstrument
              - …
            - `teacher` StaffMember
              - …
            - `student` Student — recursive
            - `scholar` boolean
          - `previousSchool` OtherSchool
            - `otherSchoolId` string, guid
            - `name` string, nullable
            - `addressLine1` string, nullable
            - `addressLine2` string, nullable
            - `locality` string, nullable
            - `administrativeArea` string, nullable
            - `country` string, nullable
            - `postcode` string, nullable
            - `primaryContactName` string, nullable
            - `email` string, nullable
            - `telephone` string, nullable
            - `website` string, nullable
            - `lastUpdated` string, date-time, nullable
            - `updatedBy` string, nullable
            - `code` string, nullable
          - `userFields` UserField[], nullable
            - `userFieldId` string, guid
            - `upi` string, guid, required
            - `displayName` string, nullable
            - `value` string, nullable
            - `lastUpdated` string, date-time, nullable
            - `updatedBy` string, nullable
            - `fromMis` boolean, required
        - `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)