Sign in

v5

latestOpenAPI 3.0.1Apache 2.02026-08-046169702.3 MB
Project components

Get project components paginated

Returns a paginated list of all components in a project. See the Get project components resource if you want to get a full list of versions without pagination.

If your project uses Compass components, this API will return a list of Compass components that are linked to issues in that project.

This operation can be accessed anonymously.

Permissions required: Browse Projects project permission for the project.

get/rest/api/3/project/{projectIdOrKey}/component

Path parameters

projectIdOrKeystring required

The project ID or project key (case sensitive).

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.

orderBy'description' | '-description' | '+description' | 'issueCount' | '-issueCount' | '+issueCount' | 'lead' | '-lead' | '+lead' | 'name' | '-name' | '+name'

Order the results by a field:

  • description Sorts by the component description.
  • issueCount Sorts by the count of issues associated with the component.
  • lead Sorts by the user key of the component's project lead.
  • name Sorts by component name.
componentSource'jira' | 'compass' | 'auto'

The source of the components to return. Can be jira (default), compass or auto. When auto is specified, the API will return connected Compass components if the project is opted into Compass, otherwise it will return Jira components. Defaults to jira.

querystring

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

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.