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

# GET /v1

`GET /v1`

## Request

- Base URL: `https://nhse-${ENV}-innovation-service-user-functions.azurewebsites.net/api`
- URL: `https://nhse-${ENV}-innovation-service-user-functions.azurewebsites.net/api/v1`
- Auth: none declared

Get users list

## Query parameters

- `skip` integer
- `take` integer
- `order` object
- `userTypes` string[]: Types of user to filter.
- `organisationUnitId` string, uuid: Id of the organisation unit the user belongs to.
- `onlyActive` boolean: List only active users or all users.
- `fields` string[]: Additional fields to display in response.

## Response `200`

Success

- object
  - `id` string: Unique identifier for user object

## Changes

- **2024-11-07** `173650e3e033`: 7 info
  - added the new optional `query` request parameter `fields`
  - added the new optional `query` request parameter `onlyActive`
  - added the new optional `query` request parameter `order`
  - added the new optional `query` request parameter `organisationUnitId`
  - …3 more

[Operation history](https://skmtc.dev/nhs-england/apis/users-api-nhs-innovation-service/changes/v1/get.md)

---

[API](https://skmtc.dev/nhs-england/apis/users-api-nhs-innovation-service.md) - [All operations](https://skmtc.dev/nhs-england/apis/users-api-nhs-innovation-service/llms.txt) - [OpenAPI document](https://skmtc.dev/nhs-england/apis/users-api-nhs-innovation-service/revisions/4c818edd79bf?raw)