---
title: "List users"
method: GET
path: "/users"
tags: ["Users"]
---

# List users

`GET /users`

## Request

- Base URL: `/v1` (relative, and the document’s source URL is not known)
- URL: `/v1/users`
- Auth: API key in header `Authorization`

List all the user in the user pool

## Query parameters

- `active` boolean
- `sort` 'forename' | 'forename:asc' | 'forename:desc' | 'lastname' | 'lastname:asc' | 'lastname:desc' | 'email' | 'email:asc' | 'email:desc' | 'id' | 'id:asc' | 'id:desc'

## Response `200`

The list of users

- UserList: A list of users
  - `users` User[]
    - `id` string: The users id
    - `forename` string: The users forename
    - `surname` string: The users surname
    - `email` string: The users email address
    - `groups` string[]: The groups the user belongs to
    - `active` boolean: Whether or not the user is active
    - `status_notes` string: Notes about the updates made to the user
    - `status` 'UNCONFIRMED' | 'CONFIRMED' | 'ARCHIVED' | 'COMPROMISED' | 'UNKNOWN' | 'RESET_REQUIRED' | 'FORCE_CHANGE_PASSWORD': The current status of the user
  - `count` integer

## Other responses

- `400`: Request rejected due to invalid parameters supplied
- `401`: Authentication information is missing or invalid
- `500`: Failed to process the request due to an internal error

---

[API](https://skmtc.dev/office-of-national-statistics/apis/identity-api.md) - [All operations](https://skmtc.dev/office-of-national-statistics/apis/identity-api/llms.txt) - [OpenAPI document](https://skmtc.dev/office-of-national-statistics/apis/identity-api/revisions/6472459b6b03?raw)