---
title: "Gets a list of all Users"
method: GET
path: "/api/v1/users/"
tags: ["Users"]
---

# Gets a list of all Users

`GET /api/v1/users/`

## Query parameters

- `search` string
- `index` integer
- `pageLength` integer

## Headers

- `X-Fields` string, mask

## Response `200`

Success

- UserPage
  - `index` integer — Starting index of the current page.
  - `isComplete` boolean — Boolean indicating if more data is available.
  - `totalNumResults` integer — Total number of results.
  - `first` string — URL to first page in results set.
  - `next` string — URL to next page in results set.
  - `prev` string — URL to last page in results set.
  - `data` UserDump[]
    - `username` string — Username of the User.
    - `email` string — Email of the User.
    - `id` integer — ID for the User resource.

---

[API](https://skmtc.net/usnistgov/apis/dioptra-rest-api.md) · [All operations](https://skmtc.net/usnistgov/apis/dioptra-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/usnistgov/dioptra-rest-api/versions/a73101579c5c/schema)