---
title: "Get a list of User Roles."
method: GET
path: "/userroles"
tags: ["UserRoles"]
---

# Get a list of User Roles.

`GET /userroles`

Lists all of the User Roles in the current Octopus Deploy instance. The results will be sorted alphabetically by name.

## Query parameters

- `ids` string[]
- `partialName` string
- `skip` integer
- `take` integer

## Response `200`

Request list of user roles.

- UserRoleResourceCollection
  - `Id` string — Gets or sets a unique identifier for this resource.
  - `Items` UserRoleResource[]
    - `CanBeDeleted` boolean
    - `Description` string
    - `GrantedSpacePermissions` string[]
    - `GrantedSystemPermissions` string[]
    - `Id` string — Gets or sets a unique identifier for this resource.
    - `LastModifiedBy` string — Gets or sets the username of the user who last modified this resource.
    - `LastModifiedOn` string, date-time — Gets or sets the date/time that this resource was last modified.
    - `Links` object — Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
    - `Name` string
    - `SpacePermissionDescriptions` string[]
    - `SupportedRestrictions` string[]
    - `SystemPermissionDescriptions` string[]
  - `ItemsPerPage` integer
  - `ItemType` string
  - `LastModifiedBy` string — Gets or sets the username of the user who last modified this resource.
  - `LastModifiedOn` string, date-time — Gets or sets the date/time that this resource was last modified.
  - `LastPageNumber` integer
  - `Links` object — Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
  - `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/revisions/b296c3a60aa5/schema)