YouTrack Standalone 2019.2 Help

My User Profile

This resource lets you read the settings of your account and your own profile in YouTrack.

Resource

/api/admin/users/me

Returned entity

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

Supported methods

Me attributes

Represents the currently logged in user in YouTrack.

Extends User

This table describes attributes of the Me 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 Specific Me

Read the profile settings of the currently logged-in user in YouTrack.

Request syntax

GET /api/admin/users/me?{fields}

Request parameters

Parameter

Type

Description

fields

String

A list of Me attributes that should be returned in the response. If no field is specified,only the entityID is returned

Sample

Sample request URI

https://example.myjetbrains.com/youtrack/api/admin/users/me?fields=id,login,name,email,savedQueries(name,id),tags(name,id),profiles(general(dateFieldFormat(presentation,pattern,datePattern),timezone(presentation,offset)),notifications(notifyOnOwnChanges,jabberNotificationsEnabled,emailNotificationsEnabled,mentionNotificationsEnabled,autoWatchOnUpdate,autoWatchOnVote,autoWatchOnComment,usePlainTextEmails,mailboxIntegrationNotificationsEnabled),timetracking(periodFormat(id)))

Sample response body

{ "login": "Mad_Max", "tags": [], "savedQueries": [], "email": "mad.max@example.com", "profiles": { "$type": "UserProfiles", "general": { "timezone": { "presentation": "Central European Summer Time (UTC/GMT +2 hours)", "offset": 120, "$type": "TimeZoneDescriptor" }, "dateFieldFormat": { "pattern": "d MMM yyyy HH:mm", "datePattern": "d MMM yyyy", "presentation": "Default date format (31 Dec 2000 23:59)", "$type": "DateFormatDescriptor" }, "$type": "GeneralUserProfile" }, "notifications": { "autoWatchOnVote": true, "usePlainTextEmails": false, "autoWatchOnComment": true, "mailboxIntegrationNotificationsEnabled": true, "autoWatchOnUpdate": false, "jabberNotificationsEnabled": true, "emailNotificationsEnabled": true, "mentionNotificationsEnabled": true, "notifyOnOwnChanges": false, "$type": "NotificationsUserProfile" }, "timetracking": { "periodFormat": { "id": "FULL", "$type": "PeriodFieldFormat" }, "$type": "TimeTrackingUserProfile" } }, "name": "Mad Max", "id": "1-7", "$type": "Me" }
Last modified: 22 October 2019