GET /rest/api/2/issue/picker

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:

This operation can be accessed anonymously.

Permissions required: None.

Servers

Query parameters

Name Type Required Description
showSubTasks Boolean No

Indicate whether to include subtasks in the suggestions list.

query String No

A string to match against text fields in the issue such as title, description, or comments.

currentIssueKey String No

The key of an issue to exclude from search results. For example, the issue the user is viewing when they perform this query.

currentJQL String No

A 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.

showSubTaskParent Boolean No

When currentIssueKey is a subtask, whether to include the parent issue in the suggestions if it matches the query.

currentProjectId String No

The ID of a project that suggested issues must belong to.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.