How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Jira Project components API

This resource represents project components. Use it to get, create, update, and delete project components. Also get components for project and get a count of issues by component.

Jira Project components API is one of 132 APIs that Jira publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Project Components. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and an API reference.

This API exposes 8 operations across 5 paths, and defines 15 schemas. It is described by OpenAPI 3.2.0, at version 1001.0.0-SNAPSHOT-82b018affa468e58f284fbe4df33536469d757df.

Requests are made against a single base URL, https://your-domain.atlassian.net.

8 operations 5 paths 15 schemas 1 DELETE5 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1001.0.0-SNAPSHOT-82b018affa468e58f284fbe4df33536469d757df
Base URL
https://your-domain.atlassian.net/rest/api/2
Authentication
OAuth 2.0, HTTP Basic
License
Terms of Service
Resource Areas
1

Authentication & Security 2

Jira Project components API declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (OAuth2) using the authorizationCode flow, exposing 186 scopes. It accepts HTTP basic authentication (basicAuth).

  • OAuth2 — OAuth2 scopes for Jira
  • basicAuth — You can access this resource via basic auth.

Paths & Operations 8

Across 5 paths, the API surfaces 8 operations — 1 DELETE, 5 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Project Components 8

This resource represents project components. Use it to get, create, update, and delete project components. Also get components for project and get a count of issues by component.

GET
/rest/api/3/component
Find components for projects
findComponentsForProjects 5 params → 200401404
POST
/rest/api/3/component
Create component
createComponent body → 201400401403404422
DELETE
/rest/api/3/component/{id}
Delete component
deleteComponent 2 params → 204401403404
GET
/rest/api/3/component/{id}
Get component
getComponent 1 param → 200401404
PUT
/rest/api/3/component/{id}
Update component
updateComponent 1 param body → 200400401403404
GET
/rest/api/3/component/{id}/relatedIssueCounts
Get component issues count
getComponentRelatedIssues 1 param → 200401404
GET
/rest/api/3/project/{projectIdOrKey}/component
Get project components paginated
getProjectComponentsPaginated 6 params → 200401404
GET
/rest/api/3/project/{projectIdOrKey}/components
Get project components
getProjectComponents 2 params → 200401404

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are ProjectComponent (16 properties), User (16 properties), ApplicationRole (14 properties), ComponentWithIssueCount (13 properties). Each schema is shown below with its type and property counts.

ComponentIssuesCount
object
Count of issues assigned to a component.
2 properties
ProjectComponent
object
Details about a project component.
16 properties
ComponentWithIssueCount
object
Details about a component with a count of the issues it contains.
13 properties
PageBean2ComponentJsonBean
object
A page of items.
7 properties
PageBeanComponentWithIssueCount
object
A page of items.
7 properties
ListWrapperCallbackGroupName
object
GroupName
object
Details about a group.
3 properties
ApplicationRole
object
Details of an application role.
14 properties
ComponentJsonBean
object
6 properties
ListWrapperCallbackApplicationRole
object
SimpleListWrapperGroupName
object
5 properties
LimitExceededResponseBean
object
7 properties
User
object
A user with details as permitted by the user's Atlassian Account privacy settings. However, be aware of these exceptions: User record deleted from Atlassian: T…
16 properties
AvatarUrlsBean
object
4 properties
SimpleListWrapperApplicationRole
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

jira-project-components-api-openapi.yml Raw ↑

Other APIs Jira publishes across the network.

Jira Cloud Platform REST API v2
Jira Service Management Operations REST API
Jira Align REST API
Jira Customer Service Management REST API
Jira Issue Comments API
Jira Issue Priorities API
Jira Issue Search API
Jira Issue Statuses API
Jira Issue Transitions API
Jira Issue Types API
Jira Issues API
Jira Projects API
Where this information came from

This is an independent, third-party profile of Jira Project components API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.