YouTrack Standalone 2017.2 Help

Get the List of Issues

GET /issue

Get a list of issues for a search query.

GET /rest/issue?{filter}&{with}&{max}&{after}

Request parameters:

Name

Type

Description

filter

string

A query to search for issues. You can also specify several queries. Results for these search filters will be returned in subsequent blocks, a list of issues per each filter. For example, if you specify:
GET https://example.com/youtrack/rest/issue?filter=for%3A+me+%23Unresolved+%23Exception&filter=for%3A+me+%23Unresolved+%23Show-stopper

In the result xml, the first block of issues will match the search query for:me #Unresolved #Exception and, after it, all issues that match the search query for:me #Unresolved #Show-stopper.

with

string

List of fields that should be included in the result. For example, the request get /issue?with=comment&with=Priority returns a list of issues only with these specific fields in the result. Other fields will not be included in the result xml.

max

integer

Maximum number of issues to get. If not provided, only 10 issues will be returned by default.

Please note that the maximum number of issues to get is also affected by the value of the Max Issues to Export parameter set on the Global Settings page of your YouTrack service. That is, if you use the max=10000 parameter in the REST API request, but the Max Issues to Export parameter of your YouTrack is limited to 5000 issues, you will not get more than 5000 issues in the response.

after

integer

A number of issues to skip before getting a list of issues. For example, if you specify after=12 in the request, then in the response you will get all issues matching request but without the first twelve issues found.

Response parameters:

Name

Description

id

Issue id in database

jiraId

If issue was imported from JIRA, represents id, that it has in JIRA

projectShortName

Short name of the issue's project

numberInProject

Number of issue in project

summary

Summary of the issue

description

Description of the issue

created

Time when issue was created (the number of milliseconds since January 1, 1970, 00:00:00 GMT represented by this date).

updated

Time when issue was last updated (the number of milliseconds since January 1, 1970, 00:00:00 GMT represented by this date).

updaterName

Login of the user, that was the last, who updated the issue

resolved

If the issue is resolved, shows time, when resolved state was last set to the issue (the number of milliseconds since January 1, 1970, 00:00:00 GMT represented by this date).

reporterName

Login of user, who created the issue

voterName

Login of user, that voted for issue

commentsCount

Number of comments in issue

votes

Number of votes for issue

permittedGroup

User group, that has permission to read this issue; if group is not set, it means that any user has access to this issue

comment

Represents issue comment (see Get Comments of an Issue)

tag

Tags, accessible to logged in user

field

Represent any field of the issue including custom fields (depending on name attribute). Number and type of fields depends on project settings.

Last modified: 7 March 2019