Permissions

This resource lets you work with permissions in YouTrack.

Available since YouTrack 2026.1.

Resource	/api/permissions
Returned entity	Permission. For the description of the entity attributes, see Supported Fields section.
Supported methods	`GET`: Read a List of Permissions.

Permission attributes

Represents a permission in YouTrack.

Available since YouTrack 2026.1.

Attributes

This table describes attributes of the Permission 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 ID of the permission. `Read-only`.
name	String	The name of the permission. `Read-only`.
description	String	The description of the permission. `Read-only`.
permissionEntityType	String	The type of the entity this permission applies to. `Read-only`.
operation	String	The operation name associated with the permission. `Read-only`.
impliedPermissions	Array of Permissions	The list of permissions implied by this permission. `Read-only`.
dependentPermissions	Array of Permissions	The list of permissions that depend on this permission. `Read-only`.
scope	PermissionScope	The scope of the permission. Possible values: Global, Organization, Project. `Read-only`.

Read a List of Permissions

Get all permissions.

Required permissions

Available for any authenticated user.

Request syntax

GET /api/permissions?{fields}&{$top}&{$skip}

null	The database ID of Permission

Request parameters

Parameter	Type	Description
fields	String	A list of Permission attributes that should be returned in the response. If no field is specified, only the `entityID` is returned.
$skip	Int	Optional. Lets you set a number of returned entities to skip before returning the first one.
$top	Int	Optional. Lets you specify the maximum number of entries that are returned in the response. If you don't set the $top value, the server limits the maximum number of returned entries. The server returns a maximum of 42 entries for most resources that return collections. For more information, see Pagination.

Parameter

Type

Description

fields

String

A list of Permission attributes that should be returned in the response. If no field is specified, only the entityID is returned.

$skip

Int

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

$top

Int

Optional. Lets you specify the maximum number of entries that are returned in the response. If you don't set the $top value, the server limits the maximum number of returned entries.

The server returns a maximum of 42 entries for most resources that return collections. For more information, see Pagination.

Sample

Get permission keys and names. The response below shows two entries from the full permission list.

Sample request

                    curl --get https://example.youtrack.cloud/api/permissions \
                      --data-urlencode fields=id,name \
                      --header 'Accept: application/json' \
                      --header 'Authorization: Bearer <permanent_token>'
                

Sample response body

                    [
                      {
                        "name": "Read Issue",
                        "id": "JetBrains.YouTrack.READ_ISSUE"
                      },
                      {
                        "name": "Create Issue",
                        "id": "JetBrains.YouTrack.CREATE_ISSUE"
                      }
                    ]
                

02 November 2026