provider Project components GET /rest/api/3/project/{projectIdOrKey}/component
@utdk/jira /rest/api/3/project/{projectIdOrKey}/component
Get project components paginated
Returns a [paginated](#pagination) list of all components in a project. See the [Get project components](#api-rest-api-3-project-projectIdOrKey-components-get) 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](#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
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. * `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.
enum: description, -description, +description, issueCount…
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
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.

getprojectcomponentspaginated
GET/rest/api/3/project/{projectIdOrKey}/component
Returns a [paginated](#pagination) list of all components in a project. See the [Get project components](#api-rest-api-3-project-projectIdOrKey-components-get) 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](#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 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. * `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.

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

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