# Operations with Specific Role

This resource lets you work with roles in YouTrack.

Available since YouTrack 2026.1.

|  Resource  |     ```GENERIC /api/roles/{roleID} ```    |
| --- | --- |
|  Returned entity  |  [Role](api-entity-Role.html). For the description of the entity attributes, see [Supported Fields](#Role-supported-fields) section.  |
|  Supported methods  |      * `POST`: [Update a Specific Role](#update-Role-method).    * `GET`: [Read a Specific Role](#get-Role-method).    * `DELETE`: [Delete a Specific Role](#delete-Role-method).    |

## Role attributes

Represents a role in YouTrack.

Available since YouTrack 2026.1.

### Attributes

This table describes attributes of the `Role` entity.

* To receive an attribute in the response from the server, specify it explicitly in the `fields` request parameter.

* To update an attribute, provide it in the body of a POST request.

|  Field  |  Type  |  Description  |
| --- | --- | --- |
|  id  |  String  |  The database ID of the role. `Read-only`.  |
|  name  |  String  |  The name of the role.  |
|  description  |  String  |  The description of the role. `Can be null`.  |
|  permissions  |  [Array of Permissions](api-entity-Permission.html)  |  The list of permissions included in the role. `Read-only`.  |
|  immutable  |  Boolean  |  True if the role is immutable, otherwise false. Immutable roles cannot be updated or deleted. `Read-only`.  |

## Update a Specific Role

Update the list of roles.

### Required permissions

Requires Admin Update App permission.

### Request syntax

```GENERIC
POST /api/roles/{roleID}?{fields}
```

|  {roleID}  |  The database ID of Role  |
| --- | --- |

### Request parameters

|  Parameter  |  Type  |  Description  |
| --- | --- | --- |
|  fields  |  String  |  A list of Role attributes that should be returned in the response. If no field is specified, only the `entityID` is returned.  |

## Read a Specific Role

Get a specific role.

### Required permissions

Requires any of the following permissions: Read Role (in at least one scope), Update Organization, or Admin Read App.

### Request syntax

```GENERIC
GET /api/roles/{roleID}?{fields}
```

|  {roleID}  |  The database ID of the role.  |
| --- | --- |

### Request parameters

|  Parameter  |  Type  |  Description  |
| --- | --- | --- |
|  fields  |  String  |  A list of Role attributes that should be returned in the response. If no field is specified, only the `entityID` is returned.  |

## Delete a Specific Role

Delete a specific role.

### Required permissions

Requires Admin Update App permission. Immutable roles cannot be deleted.

### Request syntax

```GENERIC
DELETE /api/roles/{roleID}
```

|  {roleID}  |  The database ID of the role.  |
| --- | --- |

### Request parameters

|  Parameter  |  Type  |  Description  |
| --- | --- | --- |
|  fields  |  String  |  A list of Role attributes that should be returned in the response. If no field is specified, only the `entityID` is returned.  |

