YouTrack Server
 
2019.2
Get YouTrack Standalone
You are viewing the documentation for an earlier version of YouTrack Server. View this page in the current documentation
  1. Resources for Developers
  2. Old REST API
  3. General REST API
  4. Issues Related Methods
  5. Get the List of Issues

Get the List of Issues

Last modified: 17 December 2019

GET /issue

Get a list of issues that match one or more search queries.

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

Request parameters:

Name

Type

Description

filter

string

A query to search for issues. You can specify multiple queries. Results for these search filters are 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.

note

All additional parameters described in this table ('with', 'max', and 'after') are applied to all specified filters, and (if required) should be provided after the filters.

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

The maximum number of issues to include in the result. If empty, 10 issues are returned.

note

The maximum number of issues returned by this request is also affected by the value of the Max Issues to Export setting for your YouTrack service. This setting is located on the Global Settings page. For example, if you use the max=10000 parameter in the REST API request but the Max Issues to Export setting is limited to 5000 issues, the response returns a maximum of 5000 issues.

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.

wikifyDescription

boolean

Defines whether the issue description is returned as HTML or plain text.

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

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.