Users

This resource lets you work with user settings in YouTrack.

Resource	/api/users
Returned entity	User. For the description of the entity attributes, see Supported Fields section.
Supported methods	`GET`: Read a List of Users.
Supported sub-resources	/api/users/{userID}: Operations with Specific User /api/users/{userID}/profiles/general: General User Profile /api/users/{userID}/profiles/notifications: Notifications User Profile /api/users/{userID}/tags: Issue Tags /api/users/{userID}/savedQueries: Saved Queries /api/users/{userID}/profiles/timetracking: Time Tracking User Profile

User attributes

Represents a user in YouTrack.

This table describes attributes of the User 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
login	String	The login of the user. `Read-only`. `Can be null`.
fullName	String	The full name of the user as seen in their profile. `Read-only`. `Can be null`.
email	String	The email address of the user. `Read-only`. `Can be null`.
jabberAccountName	String	The jabber account name of the user. `Read-only`. `Can be null`.
ringId	String	ID of the user in Hub. You can use this ID for operations in Hub, and for matching users between YouTrack and Hub. `Read-only`. `Can be null`.
guest	Boolean	Indicates whether the user is `guest`. `Read-only`.
online	Boolean	Indicates whether the user is currently online. `Read-only`.
banned	Boolean	Indicates whether the user is banned. `Read-only`.
tags	Array of IssueTags	Tags that belong to this user. `Read-only`.
savedQueries	Array of SavedQueries	Saved searches that belong to this user. `Read-only`.
avatarUrl	String	The URL of the user avatar. `Read-only`.
profiles	GeneralUserProfile NotificationsUserProfile TimeTrackingUserProfile	List of the user's profiles. `Read-only`.

Read a List of Users

Read the list of users in YouTrack.

Request syntax

GET /api/users?{fields}&{$top}&{$skip}

Request parameters

Parameter	Type	Description
fields	String	A list of User 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/users?fields=id,login,fullName,email,name,jabberAccount,online,avatarUrl,banned,tags(id,name,untagOnResolve,updateableBy(id,name),visibleFor(name,id),owner(id,login))&$top=2
            

Sample response body

[
  {
    "login": "guest",
    "banned": true,
    "fullName": "guest",
    "name": "guest",
    "tags": [],
    "email": null,
    "avatarUrl": "/hub/api/rest/avatar/c84fd509-7adb-44e5-b05c-fce69c70c4fc?s=48",
    "online": false,
    "id": "1-0",
    "$type": "User"
  },
  {
    "login": "jane.doe",
    "banned": false,
    "fullName": "Jane Doe",
    "name": "Jane Doe",
    "tags": [
      {
        "owner": {
          "login": "jane.doe",
          "id": "1-3",
          "$type": "User"
        },
        "untagOnResolve": false,
        "updateableBy": null,
        "visibleFor": null,
        "name": "Star",
        "id": "6-0",
        "$type": "IssueTag"
      },
      {
        "owner": {
          "login": "jane.doe",
          "id": "1-3",
          "$type": "User"
        },
        "untagOnResolve": false,
        "updateableBy": {
          "name": "All Users",
          "id": "3-0",
          "$type": "UserGroup"
        },
        "visibleFor": {
          "name": "All Users",
          "id": "3-0",
          "$type": "UserGroup"
        },
        "name": "Nice task",
        "id": "6-9",
        "$type": "IssueTag"
      },
      {
        "owner": {
          "login": "jane.doe",
          "id": "1-3",
          "$type": "User"
        },
        "untagOnResolve": true,
        "updateableBy": null,
        "visibleFor": null,
        "name": "Dangerous",
        "id": "6-10",
        "$type": "IssueTag"
      }
    ],
    "email": "jane.doe@example.com",
    "avatarUrl": "/hub/api/rest/avatar/90704ebe-c211-4906-a328-4f16ca82a5ea?s=48",
    "online": false,
    "id": "1-3",
    "$type": "User"
  }
]
            

Last modified: 28 October 2020