v4

latestOpenAPI 3.0.1Apache 2.02026-08-016169702.3 MB
Projects

Get projects paginated

Returns a paginated list of projects visible to the user.

This operation can be accessed anonymously.

Permissions required: Projects are returned only where the user has one of:

get/rest/api/3/project/search

Query parameters

startAtinteger

The index of the first item to return in a page of results (page offset).

maxResultsinteger

The maximum number of items to return per page. Must be less than or equal to 100. If a value greater than 100 is provided, the maxResults parameter will default to 100.

orderBy'category' | '-category' | '+category' | 'key' | '-key' | '+key' | 'name' | '-name' | '+name' | 'owner' | '-owner' | '+owner' | 'issueCount' | '-issueCount' | '+issueCount' | 'lastIssueUpdatedDate' | '-lastIssueUpdatedDate' | '+lastIssueUpdatedDate' | 'archivedDate' | '+archivedDate' | '-archivedDate' | 'deletedDate' | '+deletedDate' | '-deletedDate'

Order the results by a field.

  • category Sorts by project category. A complete list of category IDs is found using Get all project categories.
  • issueCount Sorts by the total number of issues in each project.
  • key Sorts by project key.
  • lastIssueUpdatedTime Sorts by the last issue update time.
  • name Sorts by project name.
  • owner Sorts by project lead.
  • archivedDate EXPERIMENTAL. Sorts by project archived date.
  • deletedDate EXPERIMENTAL. Sorts by project deleted date.
idinteger[]

The project IDs to filter the results by. To include multiple IDs, provide an ampersand-separated list. For example, id=10000&id=10001. Up to 50 project IDs can be provided.

keysstring[]

The project keys to filter the results by. To include multiple keys, provide an ampersand-separated list. For example, keys=PA&keys=PB. Up to 50 project keys can be provided.

querystring

Filter the results using a literal string. Projects with a matching key or name are returned (case insensitive).

typeKeystring

Orders results by the project type. This parameter accepts a comma-separated list. Valid values are business, service_desk, and software.

categoryIdinteger

The ID of the project's category. A complete list of category IDs is found using the Get all project categories operation.

action'view' | 'browse' | 'edit' | 'create'

Filter results by projects for which the user can:

expandstring

Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expanded options include:

  • description Returns the project description.
  • projectKeys Returns all project keys associated with a project.
  • lead Returns information about the project lead.
  • issueTypes Returns all issue types associated with the project.
  • url Returns the URL associated with the project.
  • insight EXPERIMENTAL. Returns the insight details of total issue count and last issue update time for the project.
statusstring[]

EXPERIMENTAL. Filter results by project status:

  • live Search live projects.
  • archived Search archived projects.
  • deleted Search deleted projects, those in the recycle bin.
propertiesStringList[]

EXPERIMENTAL. A list of project properties to return for the project. This parameter accepts a comma-separated list.

propertyQuerystring

EXPERIMENTAL. A query string used to search properties. The query string cannot be specified using a JSON object. For example, to search for the value of nested from {"something":{"nested":1,"other":2}} use [thepropertykey].something.nested=1. Note that the propertyQuery key is enclosed in square brackets to enable searching where the propertyQuery key includes dot (.) or equals (=) characters. Note that thepropertykey is only returned when included in properties.

Response

Returned if the request is successful.

isLastboolean

Whether this is the last page.

maxResultsinteger

The maximum number of items that could be returned.

nextPagestring uri

If there is another page of results, the URL of the next page.

selfstring uri

The URL of the page.

startAtinteger

The index of the first item returned.

totalinteger

The number of items returned.