Operations with Specific UserGroup

Last modified: 19 March 2025

This resource lets you read the list of user groups and specific user group in YouTrack.

Resource

/api/groups/{groupID}

Returned entity

UserGroup. For the description of the entity attributes, see Supported Fields section.

Supported methods

UserGroup attributes

Represents a group of users.

Related Resources

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

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. Can be null.

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 icon. Read-only. Can be null.

allUsersGroup

Boolean

True if this group contains all users, otherwise false. Read-only.

teamForProject

Project

Project that has this group set as a team. Returns null, if there is no such project. Read-only. Can be null.

Read a Specific UserGroup

Read attributes of the specific user group.

Required permissions

No permissions are required for reading basic information, for accessing all data requires Read User Group permission.

Request syntax

{groupID}

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

Sample response body

{
  "ringId": "034e661c-bfc0-4e43-8efa-acc95ac53fd4",
  "teamForProject": {
    "shortName": "SP",
    "name": "Sample Project",
    "$type": "Project"
  },
  "name": "Sample Project Team",
  "usersCount": 3,
  "id": "3-2",
  "$type": "UserGroup"
}