---
schema: rendered-html/v1
title: "Groups in the User Bundle | Developer Portal for YouTrack and Hub Documentation"
source_url: https://www.jetbrains.com/help/youtrack/devportal/resource-api-admin-customFieldSettings-bundles-user-bundleID-groups.html
generated_at: 2026-06-11T15:09:17.332098+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](jetbrains__com__help__youtrack__devportal__resource-api-admin-customfieldsettings-bundles-user.md)
- Operations with Specific UserBundle
- Sub-resources
- [Aggregated Users in the Bundle](jetbrains__com__help__youtrack__devportal__resource-api-admin-customfieldsettings-bundles-user-bundleid-aggregatedusers.md)
- [Groups in the User Bundle](resource-api-admin-customFieldSettings-bundles-user-bundleID-groups.html)
- Operations with Specific Groups in the User Bundle
- [Individual Users in the Bundle](jetbrains__com__help__youtrack__devportal__resource-api-admin-customfieldsettings-bundles-user-bundleid-individuals.md)
- [Version Bundles](jetbrains__com__help__youtrack__devportal__resource-api-admin-customfieldsettings-bundles-version.md)
- [Custom Fields](jetbrains__com__help__youtrack__devportal__resource-api-admin-customfieldsettings-customfields.md)
- [Field Types](jetbrains__com__help__youtrack__devportal__resource-api-admin-customfieldsettings-types.md)
- [Backup Files](jetbrains__com__help__youtrack__devportal__resource-api-admin-databasebackup-backups.md)
- Database Backup Settings
- Global Settings
- Organizations
- Projects
- Telemetry data
- Global Time Tracking Settings
- Agiles
- Articles
- Assigned Roles
- Commands
- Command Suggestions
- User Groups
- 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 Bundles](jetbrains__com__help__youtrack__devportal__resource-api-admin-customfieldsettings-bundles-user.md)
5. [Sub-resources](#0)
6. [Groups in the User Bundle](#0)

# Groups in the User Bundle﻿

Last modified: 30 March 2026

This resource lets you work with the user groups that are added to the specific set of users.

| Resource | ``` /api/admin/customFieldSettings/bundles/user/{bundleID}/groups ``` |
| --- | --- |
| Returned entity | UserGroup. For the description of the entity attributes, see [Supported Fields](/help/youtrack/devportal/resource-api-admin-customFieldSettings-bundles-user-bundleID-groups.html#UserGroup-supported-fields) section. |
| Supported methods | - `GET`: [Groups in the User Bundle](/help/youtrack/devportal/resource-api-admin-customFieldSettings-bundles-user-bundleID-groups.html#get_all-UserGroup-method). - `POST`: [Groups in the User Bundle](/help/youtrack/devportal/resource-api-admin-customFieldSettings-bundles-user-bundleID-groups.html#create-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 List of UserGroups﻿

Get the list of all groups that are added to specific user bundle.

### Request syntax﻿

GET /api/admin/customFieldSettings/bundles/user/{bundleID}/groups?{fields}&{$top}&{$skip}

| null | The database ID of UserGroup |
| --- | --- |

### 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. |
| $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﻿

#### Sample request﻿

https://example.youtrack.cloud/api/admin/customFieldSettings/bundles/user/8-2/groups?fields=name,id,usersCount,icon,allUsersGroup,teamForProject(name)

#### Sample response body﻿

[
  {
    "icon": null,
    "allUsersGroup": false,
    "teamForProject": {
      "name": "Rest Api Project",
      "$type": "Project"
    },
    "name": "Rest Api Project Team",
    "usersCount": 3,
    "id": "3-4",
    "$type": "UserGroup"
  },
  {
    "icon": null,
    "allUsersGroup": false,
    "teamForProject": {
      "name": "Sandbox",
      "$type": "Project"
    },
    "name": "Sandbox Team",
    "usersCount": 3,
    "id": "3-5",
    "$type": "UserGroup"
  }
]

## Add a New UserGroup﻿

Add an existing group to the bundle.

Required fields: the `id` of the group you want to add to the bundle.

### Required permissions﻿

Requires Update Project permission in all projects where the bundle is used. If the bundle is not used in any field, Update Project permission is required in at least one project.

### Request syntax﻿

POST /api/admin/customFieldSettings/bundles/user/{bundleID}/groups?{fields}

| null | The database ID of UserGroup |
| --- | --- |

### 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/admin/customFieldSettings/bundles/user/8-2/groups?fields=name,id,usersCount,icon,allUsersGroup,teamForProject(name)

#### Sample request body﻿

{ "id" : "3-5" }

#### Sample response body﻿

{
  "icon": null,
  "allUsersGroup": false,
  "teamForProject": {
    "name": "Sandbox",
    "$type": "Project"
  },
  "name": "Sandbox Team",
  "usersCount": 3,
  "id": "3-5",
  "$type": "UserGroup"
}

- [Groups in the User Bundle](/help/youtrack/devportal/resource-api-admin-customFieldSettings-bundles-user-bundleID-groups.html)
- [UserGroup attributes](/help/youtrack/devportal/resource-api-admin-customFieldSettings-bundles-user-bundleID-groups.html#UserGroup-supported-fields)
- [Read a List of UserGroups](/help/youtrack/devportal/resource-api-admin-customFieldSettings-bundles-user-bundleID-groups.html#get_all-UserGroup-method)
- [Add a New UserGroup](/help/youtrack/devportal/resource-api-admin-customFieldSettings-bundles-user-bundleID-groups.html#create-UserGroup-method)

[Aggregated Users in the Bundle](jetbrains__com__help__youtrack__devportal__resource-api-admin-customfieldsettings-bundles-user-bundleid-aggregatedusers.md)Operations with Specific Groups in the User Bundle

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

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