Server
Jira Data Center / Reference / REST API
GET

Get projects matching query

Returns a list of projects visible to the user where project name and/or key is matching the given query. Passing an empty (or whitespace only) query will match no projects. The project matches will contain a field with the query highlighted. The number of projects returned can be controlled by passing a value for 'maxResults', but a hard limit of no more than 100 projects is enforced. The projects are wrapped in a single response object that contains a header for use in the picker, specifically 'Showing X of Y matching projects' and the total number of matches for the query.

Request

Query parameters

maxResults

integer

query

string

allowEmptyQuery

boolean

Responses

Returned even when no projects match the given query.

application/json

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

Rate this page: