provider Project components GET /rest/api/3/component
@utdk/jira /rest/api/3/component
Find components for projects
Returns a [paginated](#pagination) list of all components in a project, including global (Compass) components when applicable. This operation can be accessed anonymously. **[Permissions](#permissions) required:** *Browse Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project.
projectIdsOrKeys query
The project IDs and/or project keys (case sensitive).
array
startAt query
The index of the first item to return in a page of results (page offset).
integer
maxResults query
The maximum number of items to return per page.
integer
orderBy query
[Order](#ordering) the results by a field: * `description` Sorts by the component description. * `name` Sorts by component name.
enum: description, -description, +description, name…
query query
Filter the results using a literal string. Components with a matching `name` or `description` are returned (case insensitive).
string

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.

findcomponentsforprojects
GET/rest/api/3/component
Returns a [paginated](#pagination) list of all components in a project, including global (Compass) components when applicable. This operation can be accessed anonymously. **[Permissions](#permissions) required:** *Browse Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project.

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

The index of the first item to return in a page of results (page offset).

The maximum number of items to return per page.

[Order](#ordering) the results by a field: * `description` Sorts by the component description. * `name` Sorts by component name.

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

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.findcomponentsforprojects({
  "startAt": 0,
  "maxResults": 50
})