Project components
Find components for projects
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.
get/rest/api/3/component
Query parameters
projectIdsOrKeysstring[]
The project IDs and/or project keys (case sensitive).
startAtinteger
The index of the first item to return in a page of results (page offset).
maxResultsinteger
The maximum number of items to return per page.
orderBy'description' | '-description' | '+description' | 'name' | '-name' | '+name'
Order the results by a field:
- description Sorts by the component description.
- name Sorts by component name.
querystring
Filter the results using a literal string. Components with a matching name or description are returned (case insensitive).
Response
Returned if the request is successful.