Project components

Find components for projects

Returns a paginated list of all components in a project, including global (Compass) components when applicable.

This operation can be accessed anonymously.

Permissions required: Browse Projects project permission for the project.

get/rest/api/2/component

Request

  • Base URL: https://your-domain.atlassian.net
  • URL: https://your-domain.atlassian.net/rest/api/2/component
  • Auth: one of:
    • HTTP basic
    • OAuth 2 (authorization code, authorization URL https://auth.atlassian.com/authorize, token URL https://auth.atlassian.com/oauth/token, scopes: read:jira-work)
    • none

Query parameters

projectIdsOrKeysstring[]

The project IDs and/or project keys (case sensitive).

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' | 'name' | '-name' | '+name'

Order the results by a field:

  • description Sorts by the component description.
  • name Sorts by component name.
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.

Changes

No recorded changes to this operation across all 26 revisions of this API.