This resource provides access to user groups in Hub and YouTrack.
<Hub Service URL>/api/rest/usergroups
Represents a group in Hub and YouTrack.
This table describes attributes of the
To receive an attribute in the response from the server, specify it explicitly in the
To update an attribute, provide it in the body of a POST request.
The unique identifier of the group.
The set of IDs of user groups that have been merged into this group.
Determines whether new users are added to this group automatically.
Stores an optional email domain used for auto-joining users to this group. If the user's email belongs to this domain, they are added to this group automatically.
The description of the group.
The URL of the icon of the group.
The name of the group.
The list of organizations that this group belongs to.
The list of users that belong to this group directly.
The parent group that this group belongs to.
The list of projects in which the group is used as a resource.
The list of project roles assigned to the users of this group.
The list of groups that belong to this group as sub-groups.
The number of users that belong to the group.
The list of all users that belong to this group.
Read a List of Groups
Get all groups that match the specified query.
Optional. Returns only the specified subset of the fields for each group. Use Fields Syntax to define the subset.
Optional. Lets you set a number of returned entities to skip before returning the first one.
Optional. Lets you specify the maximum number of UserGroups that are returned in the response.
Optional. Lets you specify a search query to filter the returned results. See Query Syntax for the definition of supported logical operations syntax. For the UserGroup fields and tuples, see Hub REST API Reference.
Optional Returns the list of Users sorted by a specified field. See Sorting Syntax for details. UserGroups support ordering by the following fields:
Add a Group
Create a group.
A list of UserGroup attributes that should be returned in the response. If no field is specified, only the
In this example, we create a group with the name