---
title: "Get all Exam Option Subject Links"
method: GET
path: "/Exams/OptionLinks"
tags: ["Exams"]
---

# Get all Exam Option Subject Links

`GET /Exams/OptionLinks`

**Requires permission:** *ExamAdmin*

Get all Exam Option Subject Links, and the exam options with no links.

## Query parameters

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

## Response `200`

Success - Success

- GetLinksResponse
  - `links` ExamOptionSubjectLink[]
    - `id` string, guid
    - `examOptionDescription` string, nullable
    - `examQualification` string, nullable
    - `subjectCode` string, nullable
    - `overrideHoD` string, guid, nullable
    - `hoDOverride` 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
        - `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
          - `classStaffId` string, guid
          - `classId` string, guid
          - `staffUPI` string, guid, nullable
          - `reportWriter` boolean
          - `parentsEvening` boolean
          - `staff` StaffMember — recursive
          - `class` Class — recursive
        - `students` ClassStudent[], nullable
          - `classStudentId` string, guid
          - `classId` string, guid
          - `studentUPI` string, guid, nullable
          - `student` 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
              - …
            - `relations` Relationship[], nullable
              - …
            - `inverseRelations` Relationship[], nullable
              - …
            - `classes` Class[], nullable
            - `musicLessons` MusicLesson[], nullable
              - …
            - `previousSchool` OtherSchool
              - …
            - `userFields` UserField[], 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
  - `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/fab57bf5558a/schema)