GET /rest/api/2/component

Returns a paginated list of all components in a project, including global (Compass) components when applicable.

This operation can be accessed anonymously.

Permissions required: Browse Projects project permission for the project.

Servers

Query parameters

Name Type Required Description
startAt Integer No

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

Default value: 0

query String No

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

maxResults Integer No

The maximum number of items to return per page.

Default value: 50

projectIdsOrKeys[] Array No

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

orderBy String No

Order the results by a field:

  • description Sorts by the component description.
  • name Sorts by component name.

Possible values:

  • "name"
  • "-name"
  • "-description"
  • "description"
  • "+description"
  • "+name"

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.