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

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

If your project uses Compass components, this API will return a paginated 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

Path parameters

Name Type Required Description
projectIdOrKey String Yes

The project ID or project key (case sensitive).

Query parameters

Name Type Required Description
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"

How to start integrating

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