---
title: "Find components for projects"
method: GET
path: "/rest/api/3/component"
tags: ["Project components"]
---

# Find components for projects

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

## Query parameters

- `projectIdsOrKeys` string[]
- `startAt` integer
- `maxResults` integer
- `orderBy` 'description' | '-description' | '+description' | 'name' | '-name' | '+name'
- `query` string

## Response `200`

Returned if the request is successful.

- PageBean2ComponentJsonBean — A page of items.
  - `isLast` boolean — Whether this is the last page.
  - `maxResults` integer — The maximum number of items that could be returned.
  - `nextPage` string, uri — If there is another page of results, the URL of the next page.
  - `self` string, uri — The URL of the page.
  - `startAt` integer — The index of the first item returned.
  - `total` integer — The number of items returned.
  - `values` ComponentJsonBean[] — The list of items.
    - `ari` string
    - `description` string
    - `id` string
    - `metadata` object
    - `name` string
    - `self` string

## Other responses

- `401` — Returned if the authentication credentials are incorrect or missing.
- `404` — Returned if the project is not found or the user does not have permission to view it.

---

[API](https://skmtc.net/atlassian/apis/the-jira-cloud-platform-rest-api-2.md) · [All operations](https://skmtc.net/atlassian/apis/the-jira-cloud-platform-rest-api-2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/atlassian/the-jira-cloud-platform-rest-api-2/versions/5a51740d7ab3/schema)