YouTrack Standalone 2019.2 Help

User Groups

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

Resource

/api/admin/groups

Returned entity

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

Supported methods

UserGroup attributes

Represents a group of users.

This table describes attributes of the UserGroup entity.

  • To receive an attribute in the response from server, specify it explicitly in the request parameter fields.

  • To update an attribute, provide it in the body of a POST request.

Field

Type

Description

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.

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 List of UserGroups

Read the list of user groups in YouTrack.

Request syntax

GET /api/admin/groups?{fields}&{$top}&{$skip}

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.

Sample

Sample request URI

https://example.myjetbrains.com/youtrack/api/admin/groups?fields=id,name,usersCount,teamForProject(name,shortName)&$top=5

Sample response body

[ { "teamForProject": null, "name": "All Users", "usersCount": 7, "id": "3-0", "$type": "UserGroup" }, { "teamForProject": null, "name": "Reporters", "usersCount": 0, "id": "3-1", "$type": "UserGroup" }, { "teamForProject": { "shortName": "SP", "name": "Sample Project", "$type": "Project" }, "name": "Sample Project Team", "usersCount": 3, "id": "3-2", "$type": "UserGroup" }, { "teamForProject": null, "name": "Registered Users", "usersCount": 6, "id": "3-3", "$type": "UserGroup" }, { "teamForProject": { "shortName": "RAP", "name": "Rest Api Project", "$type": "Project" }, "name": "Rest Api Project Team", "usersCount": 3, "id": "3-4", "$type": "UserGroup" } ]
Last modified: 22 October 2019