Server
Jira Service Management / Reference / REST API
GET

Get issues using JQL

Searches for issues using JQL. Sorting the jql parameter is a full JQL expression, and includes an ORDER BY clause. The fields param (which can be specified multiple times) gives a comma-separated list of fields to include in the response. This can be used to retrieve a subset of fields. A particular field can be excluded by prefixing it with a minus. By default, only navigable (*navigable) fields are returned in this search resource. Note: the default is different in the get-issue resource -- the default there all fields (*all). *all - include all fields *navigable - include just navigable fields summary,comment - include just the summary and comments -description - include navigable fields except the description (the default is *navigable for search) *all,-comment - include everything except comments GET vs POST: If the JQL query is too large to be encoded as a query param you should instead POST to this resource. Expanding Issues in the Search Result: It is possible to expand the issues returned by directly specifying the expansion on the expand parameter passed in to this resources. For instance, to expand the changelog for all the issues on the search result, it is necessary to specify changelog as one of the values to expand.

Request

Query parameters

expand

StringList

jql

string

maxResults

integer

validateQuery

boolean

fields

array<StringList>

startAt

integer

Responses

Returns a JSON representation of the search results.

application/json

SearchResultsBean
GET/api/2/search
1 2 3 4 curl --request GET \ --url 'http://{baseurl}/rest/api/2/search' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
POST

Perform search with JQL

Performs a search using JQL.

Request

Request bodyapplication/json

a JSON object containing the search request

expand

array<string>

fields

array<string>

jql

string

maxResults

integer

startAt

integer

validateQuery

boolean

Responses

Returns a JSON representation of the search results.

application/json

SearchResultsBean
POST/api/2/search
1 2 3 4 5 curl --request POST \ --url 'http://{baseurl}/rest/api/2/search' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json'

Rate this page: