---
title: "Get the two week timetable"
method: GET
path: "/timetable/two-week"
tags: ["Timetable"]
---

# Get the two week timetable

`GET /timetable/two-week`

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

Get the two week timetable for a given UPI

## Query parameters

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

## Response `200`

Success - Success

- GetTwoWeekTimetableResponse
  - `timetable` TimetableWeekView[]
    - `week` string, nullable
    - `days` TimetableDayView[]
      - `day` Day
        - `dayId` string, guid
        - `weekCode` string
        - `dayOfWeek` string
        - `order` integer
        - `showInTimetable` boolean
      - `periods` TimetablePeriodView[]
        - `period` Period
          - `periodId` string, guid
          - `description` string
          - `day` Day
            - `dayId` string, guid
            - `weekCode` string
            - `dayOfWeek` string
            - `order` integer
            - `showInTimetable` boolean
          - `startTime` string, time, nullable
          - `endTime` string, time, nullable
          - `periodNumber` integer, nullable
          - `session` string
          - `archived` boolean
          - `timetableMisId` string, nullable
          - `timetableId` string, guid, nullable
          - `timetable` Timetable
            - `timetableId` string, guid
            - `description` string
            - `archived` boolean
            - `current` boolean
            - `misId` string, nullable
            - `lastUpdated` string, date-time, nullable
            - `updatedBy` 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
              - …
          - `lesson` Lesson
            - `lessonId` string, guid
            - `class` Class
              - …
            - `dayDate` DayDate
              - …
            - `period` Period — recursive
            - `room` Room
              - …
            - `staffUpi` string, guid, nullable
            - `staff` StaffMember
              - …
            - `archived` boolean
          - `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
              - …
          - `attendanceRegistrationPermissions` AttendancePeriodRegistrationPermission[]
            - `periodId` string, guid
            - `permission` string
        - `lessons` Lesson[]
          - `lessonId` string, guid
          - `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
              - …
          - `dayDate` DayDate
            - `dayDateId` string, guid
            - `date` string, date
            - `day` Day
              - …
          - `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 — recursive
            - `house` House
              - …
            - `attendanceRegistrationPermissions` AttendancePeriodRegistrationPermission[]
              - …
          - `room` Room
            - `roomId` string, guid
            - `misId` string, nullable
            - `name` string, nullable
            - `inUse` boolean
            - `code` string, nullable
            - `timetableCode` string, nullable
            - `location` string, nullable
            - `lastUpdated` string, date-time, nullable
            - `updatedBy` 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
  - `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)