provider Project components GET /rest/api/3/project/{projectIdOrKey}/components
@utdk/jira /rest/api/3/project/{projectIdOrKey}/components
Get project components
Returns all components in a project. See the [Get project components paginated](#api-rest-api-3-project-projectIdOrKey-component-get) 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](#permissions) required:** *Browse Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project.
projectIdOrKey path required
The project ID or project key (case sensitive).
string
componentSource query
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`.
enum: jira, compass, auto

Try it

Authentication
Configure credentials for The Jira Cloud platform REST API
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.

Saved automatically to browser storage.

getprojectcomponents
GET/rest/api/3/project/{projectIdOrKey}/components
Returns all components in a project. See the [Get project components paginated](#api-rest-api-3-project-projectIdOrKey-component-get) 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](#permissions) required:** *Browse Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project.

Parameters

required

The project ID or project key (case sensitive).

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`.

Enter a gateway URL above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import jira from '@utdk/jira';

await jira.getprojectcomponents({
  "componentSource": "jira"
})