Issue Tags

This resource lets you access and work with issue tags in YouTrack.

Resource	/api/issueTags
Returned entity	IssueTag. For the description of the entity attributes, see Supported Fields section.
Supported methods	`GET`: Read a List of IssueTags. `POST`: Add a New IssueTag.
Supported sub-resources	/api/issueTags/{tagID}: Operations with Specific IssueTag /api/issueTags/{tagID}/issues: Issues

IssueTag attributes

Represents an issue tag.

Extends WatchFolder

This table describes attributes of the IssueTag 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
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.
owner	User	A user who created — hence, owns — the watch folder. `Read-only`. `Can be null`.
visibleFor	UserGroup	Group of users that can see this watch folder. If the folder is visible only for its owner, this property is null. `Can be null`.
updateableBy	UserGroup	Group of users that can update this watch folder. If only the folder's owner can update it, this property is null. `Can be null`.
name	String	The name of the issue folder. `Can be null`.

Read a List of IssueTags

Get all tags that are visible to the current user.

Request syntax

GET /api/issueTags?{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 URI

                https://example.myjetbrains.com/youtrack/api/issueTags?fields=name,owner(login,name),visibleFor(name,id),issues(idReadable,summary)&$skip=4&$top=3
            

Sample response body

                [
                  {
                    "owner": {
                      "login": "john.doe",
                      "name": "John Doe",
                      "$type": "User"
                    },
                    "issues": [],
                    "visibleFor": null,
                    "name": "Useful",
                    "$type": "IssueTag"
                  },
                  {
                    "owner": {
                      "login": "jane.doe",
                      "name": "Jane Doe",
                      "$type": "User"
                    },
                    "issues": [],
                    "visibleFor": {
                      "name": "All Users",
                      "id": "3-0",
                      "$type": "UserGroup"
                    },
                    "name": "Nice task",
                    "$type": "IssueTag"
                  },
                  {
                    "owner": {
                      "login": "john.doe",
                      "name": "John Doe",
                      "$type": "User"
                    },
                    "issues": [],
                    "visibleFor": {
                      "name": "All Users",
                      "id": "3-0",
                      "$type": "UserGroup"
                    },
                    "name": "Regression",
                    "$type": "IssueTag"
                  }
                ]
            

Add a New IssueTag

Create a new tag.

Required attributes: name

Required permissions

Requires Create Watch Folder permission.

Request syntax

POST /api/issueTags?{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

Let's create a new tag and share it with a specific user group.

Sample request URI

                https://example.myjetbrains.com/youtrack/api/issueTags?fields=name,owner(login,name),visibleFor(name,id),issues(idReadable,summary)
            

Sample request body

                {
                  "name" : "4theRelease!",
                  "visibleFor" : {
                    "id":"3-2"
                  }
                }
            

Sample response body

                {
                  "owner": {
                    "login": "john.doe",
                    "name": "John Doe",
                    "$type": "User"
                  },
                  "issues": [],
                  "visibleFor": {
                    "name": "Sample Project Team",
                    "id": "3-2",
                    "$type": "UserGroup"
                  },
                  "name": "4theRelease!",
                  "$type": "IssueTag"
                }
            

Last modified: 16 March 2020