---
title: "Get a list of Users."
method: GET
path: "/users"
tags: ["Users"]
---

# Get a list of Users.

`GET /users`

Lists all of the Users in the current Octopus Deploy instance, from all Teams. The results will be sorted alphabetically by username.

## Query parameters

- `filter` string
- `isActive` boolean
- `isServiceAccount` boolean
- `serviceAccountType` 'Standard' | 'Agent'
- `skip` integer
- `take` integer

## Response `200`

Users that meet the filter conditions

- UserResourceCollection
  - `Id` string
  - `Items` UserResource[]
    - `CanPasswordBeEdited` boolean
    - `Created` string, date-time
    - `DisplayName` string, required
    - `EmailAddress` string, email
    - `Id` string
    - `Identities` IdentityResource[]
      - `Claims` object
      - `IdentityProviderName` string
    - `IsActive` boolean
    - `IsRequestor` boolean
    - `IsService` boolean
    - `LastModifiedBy` string
    - `LastModifiedOn` string, date-time
    - `Links` object
    - `Password` string
    - `ServiceAccountType` 'Standard' | 'Agent'
    - `Username` string
  - `ItemsPerPage` integer
  - `ItemType` string
  - `LastModifiedBy` string
  - `LastModifiedOn` string, date-time
  - `LastPageNumber` integer
  - `Links` object
  - `NumberOfPages` integer
  - `TotalResults` integer

## Other responses

- `400` — Bad request. Either the payload was not structurally valid or business rules did not permit the operation.
- `404` — Not found. One or more of the entities involved in the operation was not found.

---

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