GET /rest/api/2/project/{projectIdOrKey}/component

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.

Servers

https://your-domain.atlassian.net

Path parameters

Name	Type	Required	Description
`projectIdOrKey`	String	Yes	The project ID or project key (case sensitive).

Query parameters

Name	Type	Required	Description
`startAt`	Integer	No	The index of the first item to return in a page of results (page offset). Default value: 0
`query`	String	No	Filter the results using a literal string. Components with a matching `name` or `description` are returned (case insensitive).
`maxResults`	Integer	No	The maximum number of items to return per page. Default value: 50
`componentSource`	String	No	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`. Possible values: `"auto"` `"compass"` `"jira"` Default value: "jira"
`orderBy`	String	No	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. Possible values: `"-issueCount"` `"lead"` `"-lead"` `"name"` `"-name"` `"-description"` `"+lead"` `"description"` `"issueCount"` `"+description"` `"+issueCount"` `"+name"`

How to start integrating

Add HTTP Task to your workflow definition.
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.
Click Test request to test run your request to the API and see the API's response.