---
schema: rendered-html/v1
title: "Assigned Roles | Developer Portal for YouTrack and Hub Documentation"
source_url: https://www.jetbrains.com/help/youtrack/devportal/resource-api-assignedRoles.html
generated_at: 2026-06-11T15:11:53.477790+00:00
---

Feedback

Thanks for your feedback!

Was this page helpful?

YesNo

Developer Portal for YouTrack and Hub

- Developer Portal
- Apps
- MCP Tools
- YouTrack Workflows
- YouTrack Import Scripts
- YouTrack Form API
- YouTrack REST API
- Get Started with REST API
- REST API Reference
- Entities
- Resources
- Activity Items
- Issue Activities Page
- Build Bundles
- Enum Bundles
- Owned Bundles
- State Bundles
- User Bundles
- Version Bundles
- Custom Fields
- Field Types
- Backup Files
- Database Backup Settings
- Global Settings
- Organizations
- Projects
- Telemetry data
- Global Time Tracking Settings
- Agiles
- [Articles](jetbrains__com__help__youtrack__devportal__resource-api-articles.md)
- [Assigned Roles](resource-api-assignedRoles.html)
- Operations with Specific AssignedRole
- [Commands](jetbrains__com__help__youtrack__devportal__resource-api-commands.md)
- [Command Suggestions](jetbrains__com__help__youtrack__devportal__resource-api-commands-assist.md)
- [User Groups](jetbrains__com__help__youtrack__devportal__resource-api-groups.md)
- [Issue Link Types](jetbrains__com__help__youtrack__devportal__resource-api-issuelinktypes.md)
- Issue Tag
- Issues
- Issue Count
- Permissions
- Roles
- Saved Queries
- Search Suggestions
- Tags
- Users
- My User Profile
- Issue Work Items
- REST API Use Cases
- REST API Troubleshooting
- Color Indices List
- Hub REST API

1. YouTrack REST API
2. REST API Reference
3. Resources
4. [Assigned Roles](#0)

# Assigned Roles﻿

Last modified: 31 March 2026

This resource lets you work with roles assigned to a user or a group in YouTrack.

| Resource | ``` /api/assignedRoles ``` |
| --- | --- |
| Returned entity | AssignedRole. For the description of the entity attributes, see [Supported Fields](/help/youtrack/devportal/resource-api-assignedRoles.html#AssignedRole-supported-fields) section. |
| Supported methods | - `GET`: [Read a List of AssignedRoles](/help/youtrack/devportal/resource-api-assignedRoles.html#get_all-AssignedRole-method). |

## AssignedRole attributes﻿

Represents a role assigned to a user or a group in a specific scope.

### Attributes﻿

This table describes attributes of the `AssignedRole` 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 assigned role. `Read-only`. |
| role | Role | The role that is assigned. |
| scope | AccessScope | The scope where the role is assigned. Possible values: Global, Organization, or Project. |
| holder | - User - UserGroup | The user or group that holds the role. `Read-only`. |

## Read a List of AssignedRoles﻿

Get all roles assigned to a user or a group.

Filter the roles by the role holder using query.

### Required permissions﻿

For global roles, requires Low-level Admin Read permission.

For organization roles, requires Update Organization permission.

For project roles, requires Update Project permission.

### Request syntax﻿

```
GET /api/assignedRoles?{fields}&{$top}&{$skip}&{query}
```

| null | The database ID of AssignedRole |
| --- | --- |

### Request parameters﻿

| Parameter | Type | Description |
| --- | --- | --- |
| fields | String | A list of AssignedRole 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. |
| query | String | Filter the roles by the role holder using query.  The query is a string in the following format: `holder:ID` where ID stands for the database ID of the user or group. |

### Sample﻿

#### Sample request﻿

```
https://example.youtrack.cloud/api/assignedRoles?query=holder:24-2&fields=id,role(id,name,description),holder(id,login),scope(id)
```

#### Sample response body﻿

```
[
  {
    "role": {
      "description": "Developer has the same access rights as Reporter and can also change all issues attributes.",
      "name": "Developer",
      "id": "28-21",
      "$type": "Role"
    },
    "holder": {
      "id": "23-2",
      "$type": "NestedGroup"
    },
    "scope": {
      "id": "549-6",
      "$type": "ProjectScope"
    },
    "id": "31-23",
    "$type": "AssignedRole"
  },
  {
    "role": {
      "description": null,
      "name": "Article Reader",
      "id": "28-33",
      "$type": "Role"
    },
    "holder": {
      "login": "john.smith",
      "id": "24-2",
      "$type": "User"
    },
    "scope": {
      "id": "544-0",
      "$type": "GlobalScope"
    },
    "id": "31-26",
    "$type": "AssignedRole"
  },
  {
    "role": {
      "description": "Reporter may create new issues and comments, view existing issues and comments, and manage own profile.",
      "name": "Reporter",
      "id": "28-23",
      "$type": "Role"
    },
    "holder": {
      "login": "john.smith",
      "id": "24-2",
      "$type": "User"
    },
    "scope": {
      "id": "550-0",
      "$type": "OrganizationScope"
    },
    "id": "31-56",
    "$type": "AssignedRole"
  },
  {
    "role": {
      "description": "Developer has the same access rights as Reporter and can also change all issues attributes.",
      "name": "Developer",
      "id": "28-21",
      "$type": "Role"
    },
    "holder": {
      "id": "574-7",
      "$type": "ProjectTeam"
    },
    "scope": {
      "id": "549-7",
      "$type": "ProjectScope"
    },
    "id": "31-21",
    "$type": "AssignedRole"
]
```

- [Assigned Roles](/help/youtrack/devportal/resource-api-assignedRoles.html)
- [AssignedRole attributes](/help/youtrack/devportal/resource-api-assignedRoles.html#AssignedRole-supported-fields)
- [Read a List of AssignedRoles](/help/youtrack/devportal/resource-api-assignedRoles.html#get_all-AssignedRole-method)

Operations with Specific TagOperations with Specific AssignedRole

- Privacy & Security
- Terms Of Use
- Trademarks
- Legal

Copyright © 2000–2026 JetBrains s.r.o.
