---
schema: rendered-html/v1
title: "Operations with Specific UserGroup | Developer Portal for YouTrack and Hub Documentation"
source_url: https://www.jetbrains.com/help/youtrack/devportal/operations-api-groups.html
generated_at: 2026-06-11T15:06:17.354112+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
- Assigned Roles
- Commands
- Command Suggestions
- User Groups
- [Operations with Specific UserGroup](operations-api-groups.html)
- Sub-resources
- Issue Link Types
- 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. User Groups
5. [Operations with Specific UserGroup](#0)

# Operations with Specific UserGroup﻿

Last modified: 01 April 2026

This resource provides access to the user groups in YouTrack.

| Resource | ``` /api/groups/{groupID} ``` |
| --- | --- |
| Returned entity | UserGroup. For the description of the entity attributes, see [Supported Fields](/help/youtrack/devportal/operations-api-groups.html#UserGroup-supported-fields) section. |
| Supported methods | - `GET`: [Read a Specific UserGroup](/help/youtrack/devportal/operations-api-groups.html#get-UserGroup-method). - `POST`: [Update a Specific UserGroup](/help/youtrack/devportal/operations-api-groups.html#update-UserGroup-method). - `DELETE`: [Delete a Specific UserGroup](/help/youtrack/devportal/operations-api-groups.html#delete-UserGroup-method). |

## UserGroup attributes﻿

Represents a group of users.

### Related Resources﻿

Below you can find the list of resources that let you work with this entity.

- User Groups
- User Groups in the User Bundle

### Attributes﻿

This table describes attributes of the `UserGroup` 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 user group. `Read-only`. |
| name | String | The name of the group. `Read-only`. |
| ringId | String | ID of the group in Hub. Use this ID for operations in Hub, and for matching groups between YouTrack and Hub. `Read-only`. `Can be null`. |
| usersCount | Long | The number of users in the group. `Read-only`. |
| icon | String | The URL of the group logo. `Read-only`. `Can be null`. |
| allUsersGroup | Boolean | True if this group contains all users, otherwise false. `Read-only`. |
| users | Array of Users | All users in this group, including transitive users. `Read-only`. |

## Read a Specific UserGroup﻿

Read attributes of the specific user group in YouTrack.

### Required permissions﻿

Requires access to the "Read Groups" feature, Update Project permission, or Low-Level Admin Read permission.

Additionally, you must not be filtered out by the "Visible to" list for this group.

### Request syntax﻿

```
GET /api/groups/{groupID}?{fields}
```

| {groupID} | The database ID of the user group in YouTrack. |
| --- | --- |

### Request parameters﻿

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

### Sample﻿

#### Sample request﻿

```
https://example.youtrack.cloud/api/groups/3-2?fields=id,name,usersCount,parentGroup(name),subGroups(name)
```

#### Sample response body﻿

```
{
  "subGroups": [],
  "parentGroup": {
    "name": "Reporters",
    "$type": "NestedGroup"
  },
  "usersCount": 3,
  "name": "Accounting",
  "id": "3-2",
  "$type": "NestedGroup"
}
```

## Update a Specific UserGroup﻿

Update a specific user group in YouTrack.

### Required permissions﻿

Requires permission: Update Project or Low-level Admin Write.

Additionally, you must not be filtered out by the "Updatable by" list for this group.

### Request syntax﻿

```
POST /api/groups/{groupID}?{fields}
```

| {groupID} | The database ID of the user group in YouTrack. |
| --- | --- |

### Request parameters﻿

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

### Sample﻿

#### Sample request﻿

```
https://example.youtrack.cloud/api/groups/23-154?fields=id,name,usersCount,parentGroup(name),subGroups(name)
```

#### Sample request body﻿

```
{
  "name": "General Accounting"
}
```

#### Sample response body﻿

```
{
  "subGroups": [],
  "parentGroup": {
    "name": "Reporters",
    "$type": "NestedGroup"
  },
  "usersCount": 3,
  "name": "General Accounting",
  "id": "23-154",
  "$type": "NestedGroup"
}
```

## Delete a Specific UserGroup﻿

Delete a specific user group in YouTrack while setting a successor group.

Deleting a group triggers a background synchronization process with Hub. The changes may not be reflected immediately.

Required fields: `successor`. Use the database ID of the successor group as the value.

### Required permissions﻿

Requires permission: Update Project or Low-level Admin Write.

Additionally, you must not be filtered out by the "Updatable by" list for this group.

### Request syntax﻿

```
DELETE /api/groups/{groupID}
```

| {groupID} | The database ID of the user group in YouTrack. |
| --- | --- |

### Request parameters﻿

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

### Sample﻿

#### Sample request﻿

```
https://example.youtrack.cloud/api/groups/3-2?successor=23-11
```

- [Operations with Specific UserGroup](/help/youtrack/devportal/operations-api-groups.html)
- [UserGroup attributes](/help/youtrack/devportal/operations-api-groups.html#UserGroup-supported-fields)
- [Read a Specific UserGroup](/help/youtrack/devportal/operations-api-groups.html#get-UserGroup-method)
- [Update a Specific UserGroup](/help/youtrack/devportal/operations-api-groups.html#update-UserGroup-method)
- [Delete a Specific UserGroup](/help/youtrack/devportal/operations-api-groups.html#delete-UserGroup-method)

User GroupsUsers

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

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