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 Projects API

Manage Jira projects including metadata, roles, and components.

Jira Projects API is one of 132 APIs that Jira publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Project. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an AsyncAPI specification, authentication docs, rate-limit docs, and a changelog.

This API exposes 17 operations across 14 paths, and defines 60 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 2 base URLs: https://{domain}.atlassian.net/rest/api/3, https://your-domain.atlassian.net.

17 operations 14 paths 60 schemas 1 DELETE11 GET4 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://your-domain.atlassian.net/rest/api/3
Authentication
HTTP Basic, OAuth 2.0, HTTP Bearer, OAuth 2.0
Resource Areas
1

Authentication & Security 4

Jira Projects API declares 4 security schemes for authenticating requests. It accepts HTTP basic authentication (basicAuth). It supports OAuth 2.0 (oauth2) using the authorizationCode flow, exposing 5 scopes. It accepts HTTP bearer tokens (bearerAuth). It supports OAuth 2.0 (OAuth2) using the authorizationCode flow, exposing 186 scopes.

  • basicAuth — Basic authentication using an Atlassian account email and API token. Format: email:apitoken, Base64 encoded. Generate API tokens at https://id.atlassian.com/ma…
  • oauth2 — OAuth 2.0 authorization code grant (3LO) for Jira Cloud apps.
  • bearerAuth — Bearer token authentication using a personal access token (PAT) or OAuth 2.0 access token.
  • OAuth2 — OAuth2 scopes for Jira

Paths & Operations 17

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

Projects 17

Manage Jira projects including metadata, roles, and components.

GET
/project
Jira Get All Projects
getAllProjects 3 params → 200401
GET
/project/search
Jira Get Projects Paginated
searchProjects 9 params → 200400401
GET
/project/{projectIdOrKey}
Jira Get Project
getProject 3 params → 200401404
GET
/project/{projectIdOrKey}/statuses
Jira Get All Statuses for Project
getAllStatuses 1 param → 200401404
GET
/rest/api/3/projectdeprecated
Get all projects
getRestApi3Project 3 params → 200401
POST
/rest/api/3/project
Create project
createProject body → 201400401403
GET
/rest/api/3/project/recent
Get recent projects
getRecent 2 params → 200400401
GET
/rest/api/3/project/search
Get projects paginated
getRestApi3ProjectSearch 13 params → 200400401404
DELETE
/rest/api/3/project/{projectIdOrKey}
Delete project
deleteProject 2 params → 204401404
GET
/rest/api/3/project/{projectIdOrKey}
Get project
getRestApi3ProjectByProjectIdOrKey 3 params → 200401404
PUT
/rest/api/3/project/{projectIdOrKey}
Update project
updateProject 2 params body → 200400401403404
POST
/rest/api/3/project/{projectIdOrKey}/archive
Archive project
archiveProject 1 param → 204400401403404
POST
/rest/api/3/project/{projectIdOrKey}/delete
Delete project asynchronously
deleteProjectAsynchronously 1 param → 303400401404
POST
/rest/api/3/project/{projectIdOrKey}/restore
Restore deleted or archived project
restore 1 param → 200400401404
GET
/rest/api/3/project/{projectIdOrKey}/statuses
Get all statuses for project
getRestApi3ProjectByProjectIdOrKeyStatuses 1 param → 200401404
GET
/rest/api/3/project/{projectId}/hierarchy
Get project issue type hierarchy
getHierarchy 1 param → 200400401404
GET
/rest/api/3/project/{projectKeyOrId}/notificationscheme
Get project notification scheme
getNotificationSchemeForProject 2 params → 200400401404

Schemas 60

The contract defines 60 schemas that model the data the API accepts and returns. The most detailed are Project_2 (34 properties), Project (20 properties), CreateProjectDetails (19 properties), Version_2 (19 properties). Each schema is shown below with its type and property counts.

IssueTypeWithStatus
object
Issue type with its valid statuses.
5 properties
Version
object
A project version.
10 properties
Component
object
A project component.
9 properties
AvatarUrls
object
Avatar URLs in multiple sizes.
4 properties
ProjectCategory
object
A project category.
4 properties
StatusCategory
object
A status category in Jira.
5 properties
PageBeanProject
object
A paginated list of projects.
7 properties
UserDetails
object
A Jira user.
8 properties
Project
object
A Jira project.
20 properties
StatusDetails
object
A status in Jira.
6 properties
Scope
object
The scope of the issue type (project or global).
2 properties
IssueTypeDetails
object
Details of an issue type.
9 properties
ProjectRef
object
A reference to a Jira project.
6 properties
SimpleListWrapperApplicationRole
object
5 properties
JsonTypeBean
object
The schema of a field.
6 properties 1 required
Version_2
object
Details about a project version.
19 properties
ProjectPermissions
object
Permissions which a user has on a project.
1 property
IssueTypeWithStatus_2
object
Status details for an issue type.
5 properties 5 required
ProjectRoleGroup
object
Details of the group associated with the role.
3 properties
ListWrapperCallbackGroupName
object
UpdateProjectDetails
object
Details about the project.
13 properties
Hierarchy
object
The project issue type hierarchy.
2 properties
ProjectRole
object
Details about the roles in a project.
11 properties
NotificationSchemeEvent
object
Details about a notification scheme event.
2 properties
IssueTypeDetails_2
object
Details about an issue type.
10 properties
StringList
object
SimpleLink
object
Details about the operations available in this version.
7 properties
SimplifiedHierarchyLevel
object
9 properties
ProjectComponent
object
Details about a project component.
16 properties
ProjectCategory_2
object
A project category.
4 properties
RoleActor
object
Details about a user assigned to a project role.
7 properties
StatusCategory_2
object
A status category.
5 properties
StatusDetails_2
object
A status.
7 properties
NotificationScheme
object
Details about a notification scheme.
8 properties
SimpleListWrapperGroupName
object
5 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
FieldDetails
object
Details about a field.
10 properties
ProjectIssueTypeHierarchy
object
The hierarchy of issue types within a project.
2 properties
Project_2
object
Details about a project.
34 properties
ListWrapperCallbackApplicationRole
object
ProjectRoleUser
object
Details of the user associated with the role.
1 property
ProjectInsight
object
Additional details about a project.
2 properties
ProjectLandingPageInfo
object
11 properties
EventNotification
object
Details about a notification associated with an event.
10 properties
AvatarUrlsBean
object
4 properties
ProjectIdentifiers
object
Identifiers for a project.
3 properties 3 required
CreateProjectDetails
object
Details about the project.
19 properties 2 required
VersionApprover
object
Contains details about a version approver.
4 properties
ProjectIssueTypesHierarchyLevel
object
Details of an issue type hierarchy level.
4 properties
GroupName
object
Details about a group.
3 properties
NotificationEvent
object
Details about a notification event.
4 properties
ApplicationRole
object
Details of an application role.
14 properties
UserDetails_2
object
User details permitted by the user's Atlassian Account privacy settings. However, be aware of these exceptions: User record deleted from Atlassian: This occurs…
10 properties
VersionIssuesStatus
object
Counts of the number of issues in various statuses.
4 properties
PageBeanProject_2
object
A page of items.
7 properties
IssueTypeInfo
object
Details of an issue type.
3 properties
ProjectDetails
object
Details about a project.
8 properties
Scope_2
object
The projects the item is associated with. Indicated for items associated with [next-gen projects](https://confluence.atlassian.com/x/loMyO).
2 properties
UpdatedProjectCategory
object
A project category.
4 properties
TaskProgressBeanObject
object
Details about a task.
13 properties 8 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

jira-projects-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
Atlassian Remote MCP Server
Where this information came from

This is an independent, third-party profile of Jira Projects 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.