---
title: "List User Sessions"
method: GET
path: "/v1/installs/{installSid}/users/{userSid}/sessions"
tags: ["User"]
---

# List User Sessions

`GET /v1/installs/{installSid}/users/{userSid}/sessions`

## Request

- Base URL: `https://api.smarterproctoring.com`
- URL: `https://api.smarterproctoring.com/v1/installs/{installSid}/users/{userSid}/sessions`
- Auth: API key in header `token`

Returns the active exam sessions for the specified user within the install, along with the basic exam details, the enrollment the session belongs to and the exam configuration in effect.<br/><br/>Only sessions in a `Scheduled`, `In Progress`, `Onboarding` or `Disconnected` status that belong to an active enrollment are returned.<br/><br/>Results are ordered by appointment date, soonest to oldest.<br/><br/>Pass `me` as the `userSid` to use the user the supplied token was issued to.

## Path parameters

- `installSid` string, required: Install Sid
- `userSid` string, required: User Sid, or `me` to use the user the supplied token was issued to

## Query parameters

- `offset` integer: Result offset
- `limit` integer: Number of items to return

## Response `200`

Successful

- UserSessionListResponse
  - `total` number: Total number of results
  - `first` string, nullable: URL for first page
  - `next` string, nullable: URL for next page
  - `prev` string, nullable: URL for previous page
  - `last` string, nullable: URL for last page
  - `count` number: Number of results in this page
  - `offset` number: Current offset
  - `results` UserSessionListItem[]: Exam session records
    - `sid` string, nullable: Exam session SID
    - `installSid` string, nullable: Install SID
    - `examSid` string, nullable: Exam SID
    - `courseSid` string, nullable: Course SID
    - `enrollmentSid` string, nullable: Enrollment SID
    - `examConfigurationSid` string, nullable: Exam configuration SID
    - `proctorGroupSid` string, nullable: Proctor group SID
    - `userSid` string, nullable: User SID
    - `status` string, nullable: Session status
    - `statusReason` string, nullable: Session status reason
    - `active` boolean, nullable: Whether the session is the active one in the series
    - `sessionType` string, nullable: Session type
    - `schedulingModule` string, nullable: Scheduling module
    - `workflowModule` string, nullable: Workflow module
    - `appointmentDate` string, nullable: Appointment date
    - `duration` number, nullable: Session duration in minutes
    - `timingConstraints` UserSessionTimingConstraints, nullable: Computed timing constraints for the session
      - `checkin` UserSessionTimingConstraintsCheckin, nullable: Check-in timing constraints
        - `notBefore` string, nullable: Earliest time the student can check in
        - `notAfter` string, nullable: Latest time the student can check in
    - `dateScheduled` string, nullable: Date the session was scheduled
    - `dateApproved` string, nullable: Date the session was approved
    - `inProgressDate` string, nullable: Date the session went in progress
    - `accessKey` string, nullable: Session access key
    - `examLocale` string, nullable: Exam locale
    - `createdDate` string, nullable: Created date
    - `editDate` string, nullable: Edit date
    - `exam` UserSessionExam, nullable: Basic exam details
      - `sid` string, nullable: Exam SID
      - `installSid` string, nullable: Install SID
      - `courseSid` string, nullable: Course SID
      - `title` string, nullable: Exam title
      - `bVirtualTitle` string, nullable: bVirtual exam title
      - `type` string, nullable: Exam type
      - `status` string, nullable: Exam status
      - `description` string, nullable: Exam description
      - `examCode` string, nullable: Exam code
      - `url` string, nullable: Exam URL
      - `practice` boolean, nullable: Whether the exam is a practice exam
      - `requireApproval` boolean, nullable: Whether the exam requires approval
      - `useProctorManager` boolean, nullable: Whether the exam uses proctor manager
      - `examDeliverySystemModule` string, nullable: Exam delivery system module
      - `course` UserSessionExamCourse, nullable: Basic course details
        - `sid` string, nullable: Course SID
        - `title` string, nullable: Course title
        - `code` string, nullable: Course code
    - `enrollment` UserSessionEnrollment, nullable: The enrollment the session belongs to
      - `sid` string, nullable: Enrollment SID
      - `userSid` string, nullable: User SID
      - `courseSid` string, nullable: Course SID
      - `rootInstallSid` string, nullable: Root application install SID
      - `role` string, nullable: Enrollment role
      - `state` string, nullable: Enrollment state
      - `lastSync` string, nullable: Last enrollment sync date
      - `createdDate` string, nullable: Created date
      - `editDate` string, nullable: Edit date
    - `examConfiguration` UserSessionConfiguration, nullable: The exam configuration in effect for the session
      - `sid` string, nullable: Exam configuration SID
      - `examSid` string, nullable: Exam SID
      - `enrollmentSid` string, nullable: Enrollment SID
      - `referenceExamConfigurationSid` string, nullable: Reference exam configuration SID
      - `type` string, nullable: Configuration type
      - `url` string, nullable: Exam URL
      - `password` string, nullable: Exam password (omitted for learner tokens)
      - `duration` number, nullable: Duration in minutes
      - `attempts` number, nullable: Attempts allowed
      - `locked` boolean, nullable: Whether the configuration is locked
      - `approved` boolean, nullable: Whether the configuration is approved
      - `approvedBy` string, nullable: Who approved the configuration
      - `examOpenDate` string, nullable: Exam open date
      - `examCloseDate` string, nullable: Exam close date
      - `scheduleOpenDate` string, nullable: Schedule open date
      - `scheduleCloseDate` string, nullable: Schedule close date
      - `requiredSoftware` string, nullable: Required software
      - `studentNotes` string, nullable: Notes for the student
      - `proctorNotes` string, nullable: Notes for the proctor (omitted for learner tokens)
      - `virtualCalculatorType` string, nullable: Virtual calculator type
      - `apiExamId` string, nullable: LMS api exam id
      - `examSyncStatus` string, nullable: Exam sync status
      - `permittedBathroomBreak` boolean, nullable: Bathroom break permitted
      - `permittedBathroomBreakInformation` string, nullable: Bathroom break information
      - `permittedBlankPaper` boolean, nullable: Blank paper permitted
      - `permittedBlankPaperInformation` string, nullable: Blank paper information
      - `permittedCalculator` boolean, nullable: Calculator permitted
      - `permittedCalculatorInformation` string, nullable: Calculator information
      - `permittedDictionary` boolean, nullable: Dictionary permitted
      - `permittedDictionaryInformation` string, nullable: Dictionary information
      - `permittedEarplugs` boolean, nullable: Earplugs permitted
      - `permittedEarplugsInformation` string, nullable: Earplugs information
      - `permittedFormulaSheet` boolean, nullable: Formula sheet permitted
      - `permittedFormulaSheetInformation` string, nullable: Formula sheet information
      - `permittedNotes` boolean, nullable: Notes permitted
      - `permittedNotesInformation` string, nullable: Notes information
      - `permittedOtherItems` string, nullable: Other permitted items
      - `permittedTextbook` boolean, nullable: Textbook permitted
      - `permittedTextbookInformation` string, nullable: Textbook information
      - `permittedWebsites` boolean, nullable: Websites permitted
      - `permittedWebsitesInformation` string, nullable: Websites information
      - `synchronization` UserSessionConfigurationSync: LMS synchronization information
        - `exam` UserSessionConfigurationExamSync
          - `lastRun` string, nullable: Last sync date
          - `lastRunResult` string, nullable: Last sync status
          - `nextRun` string, nullable: Next sync date
      - `createdDate` string, nullable: Created date
      - `editDate` string, nullable: Edit date

## Changes

- **2026-10-12** `da62d9723edd`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/smarterproctoring/apis/smarterproctoring-api/changes/v1/installs/:installSid/users/:userSid/sessions/get.md)

---

[API](https://skmtc.dev/smarterproctoring/apis/smarterproctoring-api.md) - [All operations](https://skmtc.dev/smarterproctoring/apis/smarterproctoring-api/llms.txt) - [OpenAPI document](https://skmtc.dev/smarterproctoring/apis/smarterproctoring-api/revisions/8215e972c639?raw)