Developer Portal for YouTrack and Hub Help

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

Supported sub-resources

User attributes

Represents a user in YouTrack. Please note that the read-only properties of a user account, like credentials, or email and so on, you can only change in Hub REST API.

Related Resources

Below you can find the list of resources that let you work with this entity.

Attributes

This table describes attributes of the User 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. Read-only.

login

String

The login of the user. Read-only.

fullName

String

The full name of the user as seen in their profile. Read-only.

email

String

The email address 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 Tags

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

UserProfiles

The profiles of the user. 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. If you don't set the $top value, the server limits the maximum number of returned entries.

The server returns a maximum of 42 entries for most resources that return collections. For more information, see Pagination.

Sample

Sample request

https://example.youtrack.cloud/api/users?fields=id,login,fullName,email,name,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": "Tag" }, { "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": "Tag" }, { "owner": { "login": "jane.doe", "id": "1-3", "$type": "User" }, "untagOnResolve": true, "updateableBy": null, "visibleFor": null, "name": "Dangerous", "id": "6-10", "$type": "Tag" } ], "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: 8 February 2024