Developer Portal for YouTrack and Hub Help

Get All Permissions of a Role


GET <REST API URL>/roles/{role id}/permissions?fields=string&$skip=int&$top=int&query=string&orderBy=string




Optional. Returns only the specified subset of the fields for each Permission. Use Fields Syntax to define the subset.


Optional. Lets you set a number of Permissions to skip before returning the first one.


Optional. Lets you set the maximum number of Permissions to return.


Optional. Lets you specify a search query to filter the returned results. See Query Syntax for the definition of supported logical operations syntax. For the Permissions, the following fields and tuples are supported:

entityType: permissionEntityType — Permissions for the given entityType

id: value — Permission with the given ID

is: global — All global permissions

key: permissionKey — Permission with the given key

name: permissionName — Permission with the given name

operation: permissionOperation — Permissions for the given operation

role: role — Permissions of the given role

service: service — Permissions provided by the given service


Optional. Returns the list of Permissions sorted by a specified field. See Sorting Syntax for details. Permissions support ordering by the following fields: entityType, key, name, operation


Response Code


200 OK

Successful request.

400 Bad Request

At least one of the request parameters is invalid. For example, a required field in the passed JSON object is missing. For details, check the error message in the response.

403 Forbidden

The requester has no access to the requested resource.

404 Not Found

The requested resource was not found.

500 Internal Server Error

Failed to process request because of the server error. For details, check the error message in the response.

Response body

{ "skip": int, "top": int, "total": int, "permissions": [permission, ...] }
Last modified: 19 June 2024