YouTrack icon

YouTrack

Get data from YouTrack API

User Group → Get

AI-generated

Summary

Retrieve detailed information about a specific user group in YouTrack by its database ID.

Inputs

  • Group ID (required) — The database ID of the user group (e.g., 3-0).
  • Additional Options — Optional parameters including a 'Fields' string to specify a comma-separated list of fields to return, such as 'id,name,usersCount,users(id,login,fullName,email),teamForProject(name,shortName)'. If omitted, only the entity ID is returned.

Output shape

a JSON object representing the user group including requested fields such as group ID, name, user count, detailed user information, and associated team/project information.

The exact structure depends on the 'Fields' parameter specified. By default, includes id, name, usersCount, detailed user info (id, login, fullName, email), and team for project (name, shortName). Only the entity ID is returned if no 'Fields' parameter is provided.

Examples

Example 1: Getting detailed information about a user group by its ID

Specify the 'Group ID' (e.g., '3-0') and optionally customize the 'Fields' option to select which details to include in the output, such as user list and team information.

Links

Discussion