Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
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 12 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 Projects. 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 4 operations across 4 paths, and defines 13 schemas. It is described by OpenAPI 3.1.0, at version 3.

Requests are made against a single base URL, https://{domain}.atlassian.net/rest/api/3.

4 operations 4 paths 13 schemas 4 GET

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 3

Jira Projects API declares 3 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). By default, every request must be authenticated.

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

Paths & Operations 4

Across 4 paths, the API surfaces 4 operations — 4 GET. Each is listed below with its method, path, parameters, and response codes.

Projects 4

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

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are Project (20 properties), Version (10 properties), IssueTypeDetails (9 properties), Component (9 properties). Each schema is shown below with its type and property counts.

Version
object
A project version.
10 properties
IssueTypeDetails
object
Details of an issue type.
9 properties
PageBeanProject
object
A paginated list of projects.
7 properties
IssueTypeWithStatus
object
Issue type with its valid statuses.
5 properties
ProjectCategory
object
A project category.
4 properties
StatusCategory
object
A status category in Jira.
5 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
Component
object
A project component.
9 properties
ProjectRef
object
A reference to a Jira project.
6 properties
AvatarUrls
object
Avatar URLs in multiple sizes.
4 properties

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