Get Issue Picker Suggestions

GET {{baseUrl}}/rest/api/3/issue/picker?query=<string>&currentJQL=<string>&currentIssueKey=<string>&currentProjectId=<string>&showSubTasks=<boolean>&showSubTaskParent=<boolean>

Returns lists of issues matching a query string. Use this resource to provide auto-completion suggestions when the user is looking for an issue using a word or string.

This operation returns two lists:

  • History Search which includes issues from the user's history of created, edited, or viewed issues that contain the string in the query parameter.
  • Current Search which includes issues that match the JQL expression in currentJQL and contain the string in the query parameter.

This operation can be accessed anonymously.

Permissions required: None.

Request Params

KeyDatatypeRequiredDescription
querystringA string to match against text fields in the issue such as title, description, or comments.
currentJQLstringA JQL query defining a list of issues to search for the query term. Note that username and userkey cannot be used as search terms for this parameter, due to privacy reasons. Use accountId instead.
currentIssueKeystringThe key of an issue to exclude from search results. For example, the issue the user is viewing when they perform this query.
currentProjectIdstringThe ID of a project that suggested issues must belong to.
showSubTasksstringIndicate whether to include subtasks in the suggestions list.
showSubTaskParentstringWhen currentIssueKey is a subtask, whether to include the parent issue in the suggestions if it matches the query.

RESPONSES

status: OK

{&quot;sections&quot;:[{&quot;label&quot;:&quot;culpa eiusmod Ut aute ullamco&quot;,&quot;sub&quot;:&quot;consecte&quot;,&quot;id&quot;:&quot;aliqua sed&quot;,&quot;msg&quot;:&quot;ea deserunt cillum in proident&quot;,&quot;issues&quot;:[{&quot;id&quot;:81942590,&quot;key&quot;:&quot;irure anim&quot;,&quot;keyHtml&quot;:&quot;dolor ut ad&quot;,&quot;img&quot;:&quot;eiusmod consequat esse id ut&quot;,&quot;summary&quot;:&quot;dolor sunt in deserunt eiusmod&quot;,&quot;summaryText&quot;:&quot;sunt pariatur nostrud&quot;},{&quot;id&quot;:50966605,&quot;key&quot;:&quot;sit&quot;,&quot;keyHtml&quot;:&quot;adipisicing aute&quot;,&quot;img&quot;:&quot;fugiat minim ex&quot;,&quot;summary&quot;:&quot;est mollit tempor sint&quot;,&quot;summaryText&quot;:&quot;enim officia&quot;}]},{&quot;label&quot;:&quot;in elit minim est amet&quot;,&quot;sub&quot;:&quot;aliqua consequat ex ipsum&quot;,&quot;id&quot;:&quot;amet cillum tempor ipsum&quot;,&quot;msg&quot;:&quot;Excepteur laborum&quot;,&quot;issues&quot;:[{&quot;id&quot;:-86776450,&quot;key&quot;:&quot;et adipisicing qui mollit dolore&quot;,&quot;keyHtml&quot;:&quot;minim proident Ut&quot;,&quot;img&quot;:&quot;ad occaecat amet&quot;,&quot;summary&quot;:&quot;Duis eu co&quot;,&quot;summaryText&quot;:&quot;ipsum reprehenderit ut&quot;},{&quot;id&quot;:68276940,&quot;key&quot;:&quot;irure Duis&quot;,&quot;keyHtml&quot;:&quot;esse incididunt in&quot;,&quot;img&quot;:&quot;Lorem laborum ut aute elit&quot;,&quot;summary&quot;:&quot;do&quot;,&quot;summaryText&quot;:&quot;laborum sit sed consequat n&quot;}]}]}