---
title: "Get Open Apply Students"
method: GET
path: "/OpenApply/Students"
tags: ["Openapply"]
---

# Get Open Apply Students

`GET /OpenApply/Students`

**Requires permissions:** *AcademicStaff* or *AcademicSupport* or *StudentFacing*

Get a list of students for the open apply

## Query parameters

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

## Response `200`

Success - Success

- GetOpenApplyStudentsResponse
  - `students` OpenApplyStudent[]
    - `id` integer
    - `openApplyId` integer, nullable
    - `customId` string, nullable
    - `applicantId` string, nullable
    - `firstName` string, nullable
    - `name` string, nullable
    - `otherName` string, nullable
    - `birthDate` string, nullable
    - `gender` string, nullable
    - `enrollmentYear` integer, nullable
    - `fullAddress` string, nullable
    - `address` string, nullable
    - `addressIi` string, nullable
    - `city` string, nullable
    - `state` string, nullable
    - `postalCode` string, nullable
    - `country` string, nullable
    - `grade` string, nullable
    - `campus` string, nullable
    - `campusId` integer, nullable
    - `tags` string, nullable
    - `status` string, nullable
    - `statusLevel` string, nullable
    - `statusChangedAt` string, nullable
    - `managebacStudentId` string, nullable
    - `mbId` string, nullable
    - `appliedAt` string, date-time, nullable
    - `enrolledAt` string, date-time, nullable
    - `inquiredAt` string, date-time, nullable
    - `siblingIds` string, nullable
    - `updatedAt` string, date-time, nullable
    - `nationality` string, nullable
    - `studentId` string, nullable
    - `profilePhotoUpdatedAt` string, date-time, nullable
    - `checklistState` string, nullable
    - `inquiredDate` string, date-time, nullable
    - `appliedDate` string, date-time, nullable
    - `admittedDate` string, date-time, nullable
    - `waitListedDate` string, date-time, nullable
    - `declinedDate` string, date-time, nullable
    - `enrolledDate` string, date-time, nullable
    - `withdrawnDate` string, date-time, nullable
    - `graduatedDate` string, date-time, nullable
    - `representative` string, nullable
    - `enrollmentDate` string, nullable
    - `sourceCampaign` string, nullable
    - `contactDate` string, nullable
    - `parentIds` string, nullable
    - `reenrollments` integer, nullable
    - `email` string, nullable
    - `surname` string, nullable
    - `preferredName` string, nullable
    - `photo` string, nullable
    - `customFields` OpenApplyStudentCustomFields
      - `id` integer
      - `openApplyId` integer, nullable
      - `roiEnquiryComments` string, nullable
      - `mobilePhone` string, nullable
      - `idAtIdType` string, nullable
      - `idAtIdNumber` string, nullable
      - `idAtIdExpiry` string, nullable
      - `idAtIdPhoto` string, nullable
      - `nationality` string, nullable
      - `idAtAcceptPrivacyPolicy` string, nullable
      - `isebScore` string, nullable
      - `ukiset` string, nullable
      - `sonsHouse` string, nullable
      - `parentLegalGuardianYn` string, nullable
      - `agentYn` string, nullable
      - `agencyName` string, nullable
      - `agentContactName` string, nullable
      - `agentContactEmail` string, nullable
      - `countryOfBirth` string, nullable
      - `nationalityAmount` string, nullable
      - `secondNationality` string, nullable
      - `thirdNationality` string, nullable
      - `nativeLanguageEnglishYn` string, nullable
      - `language` string, nullable
      - `anotherLanguageFluentlyYn` string, nullable
      - `secondLanguage` string, nullable
      - `thirdLanguage` string, nullable
      - `ethnicityCustom` string, nullable
      - `homeAddressVillageArea` string, nullable
      - `appliedBefore` string, nullable
      - `boarderDay` string, nullable
      - `bdUndecided` string, nullable
      - `linksWithSchool` string, nullable
      - `linksWithSchoolOtFather` string, nullable
      - `linksWithSchoolStaff` string, nullable
      - `linksWithSchoolOther` string, nullable
      - `applyingOtherSchools` string, nullable
      - `letterSalutation` string, nullable
      - `labelSalutation` string, nullable
      - `additionalInformation` string, nullable
      - `lessAcademicYearYn` string, nullable
      - `sixthFormSubject1` string, nullable
      - `sixthFormSubject2` string, nullable
      - `sixthFormSubject3` string, nullable
      - `sixthFormSubject4` string, nullable
      - `extraCurricularAchievements` string, nullable
      - `feeReductionYn` string, nullable
      - `feeReductionTexts` string, nullable
      - `disabilityYn` string, nullable
      - `officialDiagnosisYn` string, nullable
      - `medicalCondition` string, nullable
      - `medicalConditionDetails` string, nullable
      - `learningSupportYn` string, nullable
      - `learningSupportDetails` string, nullable
      - `medicationYn` string, nullable
      - `medicationDetails` string, nullable
      - `referralSource` string, nullable
      - `referralSourceOther` string, nullable
      - `passportUpload` string, nullable
      - `passportUpload2` string, nullable
      - `passportUpload3` string, nullable
      - `report1` string, nullable
      - `officialDiagnosisUpload` string, nullable
      - `terms` boolean, nullable
      - `nhsNumber` string, nullable
      - `gp` string, nullable
      - `healthFImmunisations` string, nullable
      - `healthFConsent` string, nullable
      - `previouslyApplied` string, nullable
      - `sixthFormSubjectChoices` string, nullable
      - `currentSchool` string, nullable
      - `currentSchoolOther` string, nullable
      - `tourConsideringBoarding` string, nullable
      - `tourRegisteredYn` string, nullable
      - `financialAid` string, nullable
      - `sizeOfParty` string, nullable
      - `tourAccessRequirement` string, nullable
      - `tourDietaryRequirements` string, nullable
      - `musicLessons` string, nullable
      - `priorSchoolLocation` string, nullable
      - `chinaHk` string, nullable
      - `priorSchoolCountry` string, nullable
      - `priorSchool` string, nullable
      - `priorSchoolHeadteacherName` string, nullable
      - `priorSchoolEmail` string, nullable
      - `consentFCoCurricularActivities` string, nullable
      - `consentFHouseAndYearContact` string, nullable
      - `consentFOneToOneLessons` string, nullable
      - `consentFAuthorization` string, nullable
      - `gsm1FConsent` boolean, nullable
      - `cityOfBirth` string, nullable
      - `homeTelephone` string, nullable
      - `gms1FUkAddress` string, nullable
      - `gms1FFirstUkAddress` string, nullable
      - `gms1FLeavingDate` string, nullable
      - `gms1FFirstCameDate` string, nullable
      - `gms1FArmedForcesGp` string, nullable
      - `gms1FAddressBeforeEnlisting` string, nullable
      - `gms1FAddressBeforeEnlistingPostcode` string, nullable
      - `gms1FPersonnelNumber` string, nullable
      - `gms1FEnlistmentDate` string, nullable
      - `gms1FDischargeDate` string, nullable
      - `gms1FDispenseMedicines` string, nullable
      - `gms1FPatientSignature` string, nullable
      - `gms1FBehalfOfPatientSignature` string, nullable
      - `gms1FNhsOrganDonorRegistration` string, nullable
      - `gms1FNhsOrganDonorRegistrationSignature` string, nullable
      - `gms1FNhsBloodDonorRegistration` string, nullable
      - `gms1FNhsBloodDonorRegistrationSignature` string, nullable
      - `gms1FDonationAddress` string, nullable
      - `gms1FDonationAddressPostcode` string, nullable
      - `gms1FNhsEngland` string, nullable
      - `learningFLearningStrategies` string, nullable
      - `learningFLearningSupportDetail` string, nullable
      - `learningFProfessionalReportsUpload` string, nullable
      - `shopFAppointment` string, nullable
      - `deviceFSuitableDevice` string, nullable
      - `lunchFAttendingBuffetLunch` string, nullable
      - `tripFMedicalRequirements` string, nullable
      - `tripFEmergencyLandlineNumber1` string, nullable
      - `tripFEmergencyLandlineNumber2` string, nullable
      - `tripFEmergencyMobileNumber1` string, nullable
      - `tripFEmergencyMobileNumber2` string, nullable
      - `tripFConsent` string, nullable
      - `isebApplicantCode` string, nullable
      - `isebVerbal` integer, nullable
      - `isebNonVerbal` integer, nullable
      - `isebMaths` string, nullable
      - `isebEnglish` integer, nullable
      - `paymentFPaymentMethod` string, nullable
      - `paymentFMonthlyDirectDebitDetails` string, nullable
      - `ddMandate` string, nullable
      - `paymentFNoEnglishBankAccountDetails` string, nullable
      - `axaPppInsOpt` string, nullable
      - `axaInsOpt` string, nullable
      - `feesRefundSchemeOpt` string, nullable
      - `feesRefundOpt` string, nullable
      - `ppeSchemeOpt` string, nullable
      - `ppeOpt` string, nullable
      - `billingContactFirstName` string, nullable
      - `billingContactLastName` string, nullable
      - `paymentFBillingContactAddress` string, nullable
      - `billingContactPhoneNumber` string, nullable
      - `billingContactEmailAddress` string, nullable
      - `paymentFAdditionalBillingContactFirstName` string, nullable
      - `paymentFAdditionalBillingContactSurname` string, nullable
      - `paymentFAdditionalBillingContactAddress` string, nullable
      - `paymentFAdditionalBillingContactTelephone` string, nullable
      - `paymentFAdditionalBillingContactEmail` string, nullable
      - `paymentFAdditionalFeePayer` string, nullable
      - `paymentFAdditionalInformation` string, nullable
      - `religion` string, nullable
      - `dietaryRequirementsYn` string, nullable
      - `dietaryRequirements` string, nullable
      - `foodAllergiesYn` string, nullable
      - `foodAllergies` string, nullable
      - `doesSonLiveWithBothParents` string, nullable
      - `anyOtherRelevantFamilyInfo` string, nullable
      - `extraCurricularAchievementsAndInfo` string, nullable
      - `additionalInformationAdmissionsPortal` string, nullable
      - `mouthguardsFAcknowledgement` string, nullable
      - `parentGuardian` string, nullable
      - `siblingsInformation` string, nullable
      - `feederSchool` string, nullable
      - `previousSchools` string, nullable
      - `healthInformation` string, nullable
      - `musicInstrument` string, nullable
      - `agentProfile` string, nullable
      - `immunizationRecord` string, nullable
      - `lunchFBuffetGuest` string, nullable
      - `parentalSignature` string, nullable
      - `feederSchoolReferenceForm` string, nullable
      - `assessmentDate` string, nullable
      - `assessmentTime` string, nullable
      - `assessmentTeacher` string, nullable
      - `assessmentGroup` string, nullable
      - `assessmentInterviewerGrade` string, nullable
      - `assessmentInterviewerComments` string, nullable
      - `assessmentScienceGrade` string, nullable
      - `assessmentScienceComments` string, nullable
      - `assessmentDramaGrade` string, nullable
      - `assessmentDramaComments` string, nullable
      - `additionalAdmissionsComments` string, nullable
      - `shortListMathsComments` string, nullable
      - `shortListMathsGrade` string, nullable
      - `shortListEnglishComments` string, nullable
      - `shortListEnglishGrade` string, nullable
      - `shortListHeadmasterComments` string, nullable
      - `shortListHeadmasterGrade` string, nullable
      - `shortlistMathsExam` string, nullable
      - `shortlistEnglishExam` string, nullable
      - `shortlistDate` string, date-time, nullable
      - `shortlistMusicGrade` string, nullable
      - `shortlistMusicComments` string, nullable
      - `offerDecision` string, nullable
      - `pref1Boarder` string, nullable
      - `pref2Boarder` string, nullable
      - `pref3Boarder` string, nullable
      - `pref1DayBoy` string, nullable
      - `pref2DayBoy` string, nullable
      - `pref3DayBoy` string, nullable
      - `houseDateCompleted` string, nullable
      - `parentDeceased` string, nullable
    - `siblingInformation` OpenApplySiblingInformation[], nullable
      - `id` integer
      - `openApplyId` integer, nullable
      - `firstName` string, nullable
      - `lastName` string, nullable
      - `attendApply` string, nullable
    - `feederSchool` OpenApplyFeederSchool
      - `id` integer
      - `openApplyId` integer, nullable
      - `feederSchoolFeederSchool` string, nullable
      - `feederSchoolOther` string, nullable
      - `recipientPrefix` string, nullable
      - `recipientFirstName` string, nullable
      - `recipientLastName` string, nullable
      - `recipientEmail` string, nullable
      - `feederSchoolCountry` string, nullable
      - `feederSchoolLocation` string, nullable
      - `feederSchoolHk` string, nullable
    - `privateNotes` PrivateNote[], nullable
      - `id` integer
      - `studentType` 0 | 1
      - `studentIdentifier` string, nullable
      - `text` string, nullable
      - `addedBy` string, nullable
      - `addedOn` string, date-time, nullable
      - `misStudent` 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
            - `lessonId` string, guid
            - `class` Class
              - …
            - `dayDate` DayDate
              - …
            - `period` Period
              - …
            - `room` Room
              - …
            - `staffUpi` string, guid, nullable
            - `staff` StaffMember
              - …
            - `archived` boolean
          - `date` string, date-time
          - `attendanceCode` string, nullable
          - `submitted` string, date-time, nullable
          - `staffName` string, nullable
          - `staffUpi` string, guid, nullable
          - `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
              - …
          - `archived` boolean
          - `periodId` string, guid, nullable
          - `periodNumber` integer, nullable
          - `period` Period
            - `periodId` string, guid
            - `description` string
            - `day` Day
              - …
            - `startTime` string, time, nullable
            - `endTime` string, time, nullable
            - `periodNumber` integer, nullable
            - `session` string
            - `archived` boolean
            - `timetableMisId` string, nullable
            - `timetableId` string, guid, nullable
            - `timetable` Timetable
              - …
            - `class` Class
              - …
            - `lesson` Lesson
              - …
            - `house` House
              - …
            - `attendanceRegistrationPermissions` AttendancePeriodRegistrationPermission[]
              - …
          - `classId` string, guid, nullable
          - `classCode` string, nullable
          - `class` Class
            - `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
              - …
          - `subjectId` string, guid, nullable
          - `subjectCode` string, nullable
          - `subject` Subject
            - `subjectId` string, guid
            - `misId` string, nullable
            - `code` string, nullable
            - `inUse` boolean, nullable
            - `department` string, nullable
            - `name` string, nullable
            - `lastUpdated` string, date-time, nullable
            - `updatedBy` string, nullable
            - `subjectHeads` SubjectHead[], nullable
              - …
            - `classes` Class[], nullable
              - …
          - `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
              - …
          - `houseCode` string, nullable
          - `notes` string, nullable
          - `futureAbsenceId` string, guid, nullable
          - `absentAlertCounted` boolean
          - `attendanceCodeObject` AttendanceCode
            - `attendanceCodeId` string, guid, nullable
            - `code` string
            - `description` string
            - `category` string
            - `eventType` string, nullable
            - `session` string, nullable
            - `order` integer, nullable
            - `display` boolean, nullable
            - `archived` boolean
            - `showInAbsenceOffex` boolean
            - `isAbsent` boolean
            - `isPresent` boolean
            - `isLate` boolean
            - `isUnauthorised` boolean
          - `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
            - `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
              - …
        - `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
            - `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
              - …
        - `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
            - `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
              - …
          - `students` Student[], nullable
        - `yearObject` 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[]
          - `updatedBy` string, nullable
        - `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
            - `classStaffId` string, guid
            - `classId` string, guid
            - `staffUPI` string, guid, nullable
            - `reportWriter` boolean
            - `parentsEvening` boolean
            - `staff` StaffMember
              - …
            - `class` Class — recursive
          - `students` ClassStudent[], nullable
            - `classStudentId` string, guid
            - `classId` string, guid
            - `studentUPI` string, guid, nullable
            - `student` Student — recursive
        - `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
            - `id` integer
            - `description` string, nullable
            - `archived` boolean
            - `orchestralOrder` integer
          - `teacher` 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
              - …
          - `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
      - `openApplyStudent` OpenApplyStudent — recursive
  - `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)