Developer Portal for YouTrack and Hub Help

Operations with Specific UserGroup

This resource lets you work with the groups added to the project team.

Resource

/api/admin/projects/{projectID}/team/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.

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.

Remove a Group from the Project Team

Remove a group from the project team.

Required permissions

Requires permissions: Update Project.

Request syntax

DELETE /api/admin/projects/{projectID}/team/groups/{groupID}

{groupID}

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/projects/0-6/team/groups/23-1
20 May 2026