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

# List Users

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

Returns a paginated list of users for the specified install.

## Path parameters

- `installSid` string, required — Install Sid

## Query parameters

- `admin` boolean — Filter admin user
- `offset` integer — Result offset
- `limit` integer — Number of items to return
- `sortKeys` string[] — Keys to sort the data
- `sortOrder` 'ASC' | 'DESC' — Order of sorting
- `firstName` string — First Name
- `lastName` string — Last Name
- `email` string — Email
- `sisId` string — SIS Id
- `lmsId` string — LMS Id
- `apiId` string — API Id
- `externalId` string — External Id

## Response `200`

Successful

- UserListResponse
  - `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` UserListItem[] — User records
    - `sid` string, nullable
    - `firstName` string, nullable
    - `lastName` string, nullable
    - `email` string, nullable
    - `username` 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)