---
title: "Get Houses"
method: GET
path: "/Houses"
tags: ["Houses"]
---

# Get Houses

`GET /Houses`

**Requires permissions:** *AcademicStaff* or *AcademicSupport* or *Guardian* or *Parent* or *Student* or *StudentFacing*

Gets a list of houses with sorting and filtering options.<br />Supported Includes: `Staff`, `Staff.Staff`

## Query parameters

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

## Response `200`

Success - Got houses

- GetHousesResponse
  - `meta` Meta
    - `page` integer
    - `pageSize` integer
    - `total` integer
  - `houses` 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
          - `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
              - …
        - `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

## Other responses

- `400` — An Error Occurred - Could not get houses
- `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)