---
schema: rendered-html/v1
title: "UserGroup | Developer Portal for YouTrack and Hub Documentation"
source_url: https://www.jetbrains.com/help/youtrack/devportal/api-entity-UserGroup.html
generated_at: 2026-06-11T14:57:29.700427+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
- AccessScope
- ActivityCategory
- ActivityCursorPage
- ActivityItem
- Agile
- AgileColumn
- AgileSharingSettings
- AgileStatus
- AppearanceSettings
- ArticleAttachment
- ArticleComment
- AssignedRole
- BackupError
- BackupFile
- BackupStatus
- BaseArticle
- BaseWorkItem
- Bundle
- BundleElement
- ChangesProcessor
- ColorCoding
- ColumnSettings
- CommandList
- CommandVisibility
- CustomField
- CustomFieldCondition
- CustomFieldDefaults
- DatabaseAttributeValue
- DatabaseBackupSettings
- DateFormatDescriptor
- DuplicateVote
- DurationValue
- EmailSettings
- Event
- ExternalArticle
- ExternalIssue
- FieldStyle
- FieldType
- FilterField
- GeneralUserProfile
- GlobalSettings
- GlobalTimeTrackingSettings
- Issue
- IssueAttachment
- IssueComment
- IssueCountResponse
- IssueCustomField
- IssueFolder
- IssueKey
- IssueLink
- IssueLinkType
- IssueTimeTracking
- IssueVoters
- IssueWatcher
- IssueWatchers
- License
- LocaleDescriptor
- LocaleSettings
- Logo
- NotificationSettings
- NotificationsUserProfile
- OnlineUsers
- Organization
- ParsedCommand
- PeriodFieldFormat
- PeriodValue
- Permission
- ProjectColor
- ProjectCustomField
- ProjectTimeTrackingSettings
- PullRequest
- PullRequestChange
- PullRequestState
- Reaction
- RestCorsSettings
- Role
- SearchSuggestions
- Sprint
- SprintsSettings
- StorageEntry
- Suggestion
- SwimlaneSettings
- SwimlaneValue
- SystemSettings
- TagSharingSettings
- Telemetry
- TextFieldValue
- TimeTrackingUserProfile
- [TimeZoneDescriptor](jetbrains__com__help__youtrack__devportal__api-entity-timezonedescriptor.md)
- [User](jetbrains__com__help__youtrack__devportal__api-entity-user.md)
- [UserGroup](api-entity-UserGroup.html)
- AllUsersGroup
- NestedGroup
- ProjectTeam
- RegisteredUsersGroup
- [UserProfiles](jetbrains__com__help__youtrack__devportal__api-entity-userprofiles.md)
- [UserType](jetbrains__com__help__youtrack__devportal__api-entity-usertype.md)
- [VcsChange](jetbrains__com__help__youtrack__devportal__api-entity-vcschange.md)
- VcsServer
- Visibility
- WIPLimit
- WatchFolderSharingSettings
- WorkItemAttribute
- WorkItemAttributePrototype
- WorkItemAttributeValue
- WorkItemProjectAttribute
- WorkItemType
- WorkTimeSettings
- Resources
- REST API Use Cases
- REST API Troubleshooting
- Color Indices List
- Hub REST API

1. YouTrack REST API
2. REST API Reference
3. Entities
4. [UserGroup](#0)

# UserGroup﻿

Last modified: 30 March 2026

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

Extended by:

- AllUsersGroup
- RegisteredUsersGroup
- ProjectTeam
- NestedGroup

## 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](jetbrains__com__help__youtrack__devportal__api-entity-user.md) | All users in this group, including transitive users. `Read-only`. |

- [UserGroup](/help/youtrack/devportal/api-entity-UserGroup.html)
- [Related Resources](/help/youtrack/devportal/api-entity-UserGroup.html#dfuo7q_3)
- [Attributes](/help/youtrack/devportal/api-entity-UserGroup.html#dfuo7q_6)

VcsUnresolvedUserAllUsersGroup

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

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