Developer Portal for YouTrack and Hub Help

Issues

This resource lets you get a list of issues that the specific tag is added to.

  • The default issue sorting is sort by: updated desc.

  • If you don't provide the $top parameter, the number of returned issues is limited to the Max issues to export value in the Global Settings of your YouTrack.

Resource

/api/issueTags/{tagID}/issues

Returned entity

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

Supported methods

Issue attributes

Represents an issue in YouTrack.

This table describes attributes of the Issue 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 database ID of the issue. Read-only.

idReadable

String

The issue ID as seen in the YouTrack interface. Read-only.

created

Long

The timestamp of the moment when the issue was created. Read-only. Can be null.

updated

Long

The timestamp of the last update of the issue. Read-only. Can be null.

resolved

Long

The timestamp of the moment when the issue was assigned a state that is considered to be resolved. null if the issue is still in an unresolved state. Read-only. Can be null.

numberInProject

Long

The issue number in the project. Read-only.

project

Project

The project where the issue belongs. Can be null.

summary

String

The issue summary. Can be null.

description

String

The issue description. Can be null.

wikifiedDescription

String

The issue description as shown in the UI after processing wiki/Markdown markup (including HTML markup). Read-only.

reporter

User

The user who reported (created) the issue. Read-only. Can be null.

updater

User

The user who last updated the issue. Read-only. Can be null.

draftOwner

User

The creator of the draft if the issue is a draft. null if the issue is reported. Read-only. Can be null.

isDraft

Boolean

true if this issue is a draft, false if it is reported. Read-only.

visibility

Visibility

Visibility settings of the issue. They describe who is allowed to see the issue. Can be null.

votes

Int

The sum of votes for this issue and votes for its duplicates. A reporter of a duplicate issue automatically becomes a voter for the main issue. Read-only.

comments

Array of IssueComments

A list of comments for the issue.

commentsCount

Int

The number of comments in the issue. Read-only.

tags

Array of IssueTags

The list of tags that are added to the issue.

links

Array of IssueLinks

Issue links (for example, `relates to`, `parent for`, and so on). Read-only.

externalIssue

ExternalIssue

Reference to the issue or similar object in an originating third-party system. Read-only. Can be null.

customFields

Array of IssueCustomFields

The collection of custom fields that are present in the issue. Read-only.

voters

IssueVoters

Object that contains data about voters for the issue and for its duplicates. Read-only.

watchers

IssueWatchers

Object that contains data about users watching this issue or its duplicates. Read-only.

attachments

Array of IssueAttachments

The list of attachments in the issue.

subtasks

IssueLink

The list of sub-tasks of the issue. Read-only.

parent

IssueLink

The parent issue for the current one. If the issue is not a sub-task of any issue, then null. Read-only.

Read a List of Issues

Get all issues that the specific tag is added to.

Request syntax

GET /api/issueTags/{tagID}/issues?{fields}&{$top}&{$skip}&{customFields}

Request parameters

Parameter

Type

Description

fields

String

A list of Issue 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.

customFields

String

The name of the custom field to show in the response. When you use this parameter and request the custom field data in the request URL, the response only shows the requested custom fields instead of all of them.

To show more than one custom field, use this parameter several times.

See Sample 2 for reference.

Sample 1

Sample request

https://example.youtrack.cloud/api/issueTags/6-4/issues?fields=id,idReadable,summary

Sample response body

[ { "idReadable": "RAP-2", "summary": "Example for Get specific issue tag", "id": "2-62", "$type": "Issue" }, { "idReadable": "RAP-4", "summary": "New issue with new tag", "id": "2-66", "$type": "Issue" } ]

Sample 2

Sample request

https://example.youtrack.cloud/api/issueTags/6-4/issues?fields=id,idReadable,summary,customFields(name,value(name))&customFields=type&customFields=assignee&customFields=priority

Sample response body

[ { "idReadable": "NP-117", "summary": "Poster design for the conference", "customFields": [ { "value": { "name": "Jane Doe", "$type": "User" }, "name": "Assignee", "$type": "SingleUserIssueCustomField" }, { "value": { "name": "Normal", "$type": "EnumBundleElement" }, "name": "Priority", "$type": "SingleEnumIssueCustomField" }, { "value": { "name": "Task", "$type": "EnumBundleElement" }, "name": "Type", "$type": "SingleEnumIssueCustomField" } ], "id": "99-8", "$type": "Issue" }, { "idReadable": "NP-1", "summary": "Deployment broken", "customFields": [ { "value": { "name": "John Smith", "$type": "User" }, "name": "Assignee", "$type": "SingleUserIssueCustomField" }, { "value": { "name": "Critical", "$type": "EnumBundleElement" }, "name": "Priority", "$type": "SingleEnumIssueCustomField" }, { "value": { "name": "Bug", "$type": "EnumBundleElement" }, "name": "Type", "$type": "SingleEnumIssueCustomField" } ], "id": "99-12", "$type": "Issue" } ]
Last modified: 29 September 2022