Developer Portal for YouTrack and Hub Help

Issue Tags

This sub-resource lets you work with the tags that are added to the specific issue.

Resource

/api/issues/{issueID}/tags

Returned entity

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

Supported methods

IssueTag attributes

Represents an issue tag.

Extends WatchFolder

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

issues

Array of Issues

The collection of issues that this tag is added to.

color

FieldStyle

The color settings of the tag.

untagOnResolve

Boolean

If true, this tag will be automatically removed from an issue when the issue is resolved.

visibleFor

UserGroup

Deprecated. Use the readSharingSettings attribute instead.

Group of users that can see this tag. If the tag is visible only to its owner, this property is null.

Can be null.

updateableBy

UserGroup

Deprecated. Use the updateSharingSettings attribute instead.

Group of users that can update this tag. If only the tag's owner can update it, this property is null.

Can be null.

readSharingSettings

WatchFolderSharingSettings

Users and groups that can see this tag. If the tag is visible only to its owner, this property contains an empty array. Read-only.

tagSharingSettings

TagSharingSettings

Users and groups that can use this tag. These users can add the tag to or remove the tag from the issues that they also have permission to view and update. If the tag can be used only by its owner, this property contains an empty array. Read-only.

updateSharingSettings

WatchFolderSharingSettings

Users and groups that can update this tag. If only the tag's owner can update it, this property contains an empty array. Read-only.

owner

User

A user who created — hence, owns — the watch folder. Read-only. Can be null.

name

String

The name of the issue folder. Can be null.

Read a List of IssueTags

Get all tags added to the issue that are visible to the current user.

Request syntax

GET /api/issues/{issueID}/tags?{fields}&{$top}&{$skip}

Request parameters

Parameter

Type

Description

fields

String

A list of IssueTag 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

https://example.youtrack.cloud/api/issues/NP-12/tags?fields=name,owner(login,name),visibleFor(name,id)

Sample response body

[ { "owner": { "login": "john.smith", "name": "John Smith", "$type": "User" }, "visibleFor": { "name": "All Users", "id": "23-0", "$type": "UserGroup" }, "name": "Blocked by dependency", "$type": "IssueTag" }, { "owner": { "login": "jane.doe", "name": "Jane Doe", "$type": "User" }, "visibleFor": { "name": "Developers", "id": "23-38", "$type": "UserGroup" }, "name": "overdue", "$type": "IssueTag" } ]

Add a Tag to the Issue

Tag the issue with an existing tag. Put the database ID of the tag in the request body.

Required permissions

Requires permissions: Read Issue

The user must be either the tag owner or be a part of the user group that can use the tag.

Request syntax

POST /api/issues/{issueID}/tags?{fields}

Request parameters

Parameter

Type

Description

fields

String

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

Sample

Sample request

https://example.youtrack.cloud/api/issues/NP-12/tags?fields=id,name,owner(login,name),visibleFor(name,id)

Sample request body

{ "id": "146-25" }

Sample response body

{ "owner": { "login": "jane.doe", "name": "Jane Doe", "$type": "User" }, "visibleFor": { "name": "All Users", "id": "23-0", "$type": "UserGroup" }, "name": "productivity", "id": "146-25", "$type": "IssueTag" }
Last modified: 29 September 2022