---
title: "Returns all users."
method: GET
path: "/users"
---

# Returns all users.

`GET /users`

## Query parameters

- `UserID` string
- `InternalID` string
- `Email` string
- `FirstName` string
- `LastName` string
- `AccessCode` string
- `OrderBy` string
- `ExcludeCustomQuestions` boolean
- `limit` integer
- `offset` integer
- `AssessmentKey` string
- `AdministrativeGroupKey` string

## Response `200`

A list of users.

- object
  - `NumPages` string — Total number of pages.
  - `Page` string — Current page number.
  - `PageSize` string — Number of records per page.
  - `Total` string — Total number of records.
  - `Start` string — Start record index for the current page.
  - `End` string — End record index for the current page.
  - `FirstPageUri` string
  - `LastPageUri` string
  - `PreviousPageUri` string — Empty string if on first page.
  - `NextPageUri` string — Empty string if on last page.
  - `User` union — One or more user records. Returns an object when there is a single result, or an array when there are multiple results.
    - UserRecord
      - `UserId` string
      - `AssessmentKey` string — The assessment key for the group the user belongs to.
      - `AdministrativeGroupKey` string — The administrative group key for the user.
      - `FirstName` string
      - `LastName` string
      - `Email` string, email
      - `InternalId` string
      - `AccessCode` string — The user's assessment access (PIN) code.
      - `CompletionPercentage` string — Percentage of the assessment completed (0-100).
      - `DateTimeStarted` string, date-time
      - `DateTimeLastUpdated` union — Date the assessment was last updated. Empty array if not yet updated.
        - string, date-time
        - unknown[]
          - unknown
      - `DateTimeCompleted` union — Date the assessment was completed. Empty array if not yet completed.
        - string, date-time
        - unknown[]
          - unknown
      - `HowManyCourses` unknown[]
        - unknown
      - `AgeRange` unknown[]
        - unknown
      - `Gender` unknown[]
        - unknown
      - `Uri` string — Relative URI to retrieve this user's details.
    - UserRecord[]
      - `UserId` string
      - `AssessmentKey` string — The assessment key for the group the user belongs to.
      - `AdministrativeGroupKey` string — The administrative group key for the user.
      - `FirstName` string
      - `LastName` string
      - `Email` string, email
      - `InternalId` string
      - `AccessCode` string — The user's assessment access (PIN) code.
      - `CompletionPercentage` string — Percentage of the assessment completed (0-100).
      - `DateTimeStarted` string, date-time
      - `DateTimeLastUpdated` union — Date the assessment was last updated. Empty array if not yet updated.
        - string, date-time
        - unknown[]
          - unknown
      - `DateTimeCompleted` union — Date the assessment was completed. Empty array if not yet completed.
        - string, date-time
        - unknown[]
          - unknown
      - `HowManyCourses` unknown[]
        - unknown
      - `AgeRange` unknown[]
        - unknown
      - `Gender` unknown[]
        - unknown
      - `Uri` string — Relative URI to retrieve this user's details.

## Changes

- **2026-06-09** `793d3e626da1` — 1 info
  - added the media type `application/json` for the response with the status `200`

[Change history](https://skmtc.dev/smarterservices/apis/multi-server-api/changes/users/get.md)

---

[API](https://skmtc.dev/smarterservices/apis/multi-server-api.md) · [All operations](https://skmtc.dev/smarterservices/apis/multi-server-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/smarterservices/multi-server-api/revisions/793d3e626da1/schema)