---
title: "List Appointments"
method: GET
path: "/v1/installs/{installSid}/reports/appointments"
tags: ["Reports"]
---

# List Appointments

`GET /v1/installs/{installSid}/reports/appointments`

Returns all appointments based on the given filter parameters.

## Path parameters

- `installSid` string, required — Install Sid

## Query parameters

- `offset` integer — Result offset
- `limit` integer — Number of items to return
- `courseSid` string — Course sid
- `examSid` string — Exam sid
- `courseOfferingSid` string — Course offering sid
- `type` 'b-virtual' | 'examity' | 'proctoru' | 'register-blast' | 'instructor-as-proctor' | 'messaging' | 'ad-hoc' | 'vtc' | 'automated' — Type of the appointment
- `status` 'Needs Proctor' | 'Scheduled' | 'Cancelled' | 'In Progress' | 'Closed' — Status of the appointment
- `reviewStatus` 'pending' | 'complete' | 'not-required' — If the session needs to be reviewed and/or if it has been reviewed.
- `examStatus` 'active' | 'draft' | 'deleted' — Status of the exam
- `appointmentAfter` string — Appointments after date
- `appointmentBefore` string — Appointments before date
- `learnerFirstName` string — learner first name
- `learnerLastName` string — Learners last name
- `learnerEmail` string — Learners email
- `learnerSid` string — Learners sid
- `courseTitle` string — Course title
- `examTitle` string — Exam title

## Response `200`

Successful

- AppointmentReportResponse
  - `total` number, nullable
  - `first` string, nullable
  - `next` string, nullable
  - `prev` string, nullable
  - `last` string, nullable
  - `count` number, nullable
  - `offset` number, nullable
  - `results` AppointmentReportItem[]
    - `sid` string, nullable
    - `examSid` string, nullable
    - `enrollmentSid` string, nullable
    - `instructorProctorSid` string, nullable
    - `status` string, nullable
    - `sessionType` string, nullable
    - `schedulingModule` string, nullable
    - `proctorReviewProcessSid` string, nullable
    - `appointmentDate` string, nullable
    - `dateApproved` string, nullable
    - `dateScheduled` string, nullable
    - `externalAppointmentId` string, nullable
    - `externalReservedAppointmentId` string, nullable
    - `externalReservedAppointmentExpires` string, nullable
    - `recordingStartDate` string, nullable
    - `sessionReportCount` number, nullable
    - `series` Series
    - `reviewByDate` string, nullable
    - `reviewCompletedDate` string, nullable
    - `reviewRequired` boolean, nullable
    - `platformVersion` string, nullable
    - `systemCheckStartDate` string, nullable
    - `systemCheckEndDate` string, nullable
    - `mandatoryRoomScanVideo` boolean, nullable
    - `mutedAnnotations` MutedAnnotations
    - `exam` Exam, nullable
      - `sid` string, nullable
      - `courseSid` string, nullable
      - `title` string, nullable
      - `type` string, nullable
      - `description` string, nullable
      - `useProctorManager` boolean, nullable
      - `requireApproval` boolean, nullable
      - `enableAppointmentSuggestions` boolean, nullable
      - `url` string, nullable
      - `status` string, nullable
      - `instructorName` string, nullable
      - `courseName` string, nullable
      - `totalSessions` number, nullable
      - `needsProctorSessions` number, nullable
      - `platformVersion` string, nullable
    - `enrollment` Enrollment, nullable
      - `userSid` string, nullable
      - `enrollmentSid` string, nullable
      - `courseSid` string, nullable
      - `role` string, nullable
      - `firstName` string, nullable
      - `lastName` string, nullable
      - `email` string, nullable
      - `synchronization` Synchronization, nullable
        - `failure1` string, nullable
        - `failure2` string, nullable
        - `failure3` string, nullable
        - `failure4` string, nullable
        - `lastSync` string, nullable
      - `createdDate` string, nullable
      - `editDate` string, nullable
      - `user` User
      - `course` Course
    - `course` Model10, nullable
      - `sid` string, nullable
      - `title` string, nullable
      - `code` string, nullable
      - `synchronization` Model9, nullable
        - `enrollment` Model8, nullable
          - `lastRun` string, nullable
          - `lastRunResult` string, nullable
          - `nextRun` string, nullable
      - `createdDate` string, nullable
      - `editDate` string, nullable
      - `offering` Offering, nullable
        - `sid` string, nullable
        - `lastActivityDate` string, nullable
        - `title` string, nullable
        - `matchStrings` string, nullable
        - `startDate` string, nullable
        - `endDate` string, nullable
        - `createdDate` string, nullable
        - `editDate` string, nullable
    - `examConfiguration` ExamConfiguration, nullable
      - `sid` string, nullable
      - `examSid` string, nullable
      - `enrollmentSid` string, nullable
      - `examOpenDate` string, nullable
      - `examCloseDate` string, nullable
      - `scheduleOpenDate` string, nullable
      - `scheduleCloseDate` string, nullable
      - `password` string, nullable
      - `duration` number, nullable
      - `attempts` number, nullable
      - `approved` boolean, nullable
      - `approvedBy` string, nullable
      - `requiredSoftware` string, nullable
      - `studentNotes` string, nullable
      - `permittedBathroomBreak` boolean, nullable
      - `permittedBathroomBreakInformation` string, nullable
      - `permittedBlankPaper` boolean, nullable
      - `permittedBlankPaperInformation` string, nullable
      - `permittedCalculator` boolean, nullable
      - `permittedCalculatorInformation` string, nullable
      - `permittedDictionary` boolean, nullable
      - `permittedDictionaryInformation` string, nullable
      - `permittedEarplugs` boolean, nullable
      - `permittedEarplugsInformation` string, nullable
      - `permittedFormulaSheet` boolean, nullable
      - `permittedFormulaSheetInformation` string, nullable
      - `permittedNotes` boolean, nullable
      - `permittedNotesInformation` string, nullable
      - `permittedOtherItems` string, nullable
      - `permittedTextbook` boolean, nullable
      - `permittedTextbookInformation` string, nullable
      - `permittedWebsites` boolean, nullable
      - `permittedWebsitesInformation` string, nullable
      - `synchronization` Model12, nullable
        - `exam` Model11, nullable
          - `lastRun` string, nullable
          - `lastRunResult` string, nullable
          - `nextRun` string, nullable
      - `proctorNotes` string, nullable
      - `proctorTypes` string[], nullable
      - `instructorAsProctor` Model14[], nullable
      - `createdDate` string, nullable
      - `editDate` string, nullable

---

[API](https://skmtc.net/smarterproctoring/apis/smarterproctoring-api-2.md) · [All operations](https://skmtc.net/smarterproctoring/apis/smarterproctoring-api-2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/smarterproctoring/smarterproctoring-api-2/versions/561e0d9fd244/schema)