Operations with Specific Role

This resource lets you work with roles in YouTrack.

Resource	/api/roles/{roleID}
Returned entity	Role. For the description of the entity attributes, see Supported Fields section.
Supported methods	`POST`: Update a Specific Role. `GET`: Read a Specific Role. `DELETE`: Delete a Specific Role.

Role attributes

Represents a role in YouTrack.

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	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 the list of roles.

Requires Admin Update App permission.

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

{roleID}	The database ID of Role

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.

Get a specific role.

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

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

{roleID}	The database ID of the role.

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.

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

DELETE /api/roles/{roleID}

{roleID}	The database ID of the role.

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.

24 March 2026