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

Create, read, update, delete, and transition Jira issues.

Jira Issues 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 Issues. 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 2 paths, and defines 36 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 2 paths 36 schemas 1 DELETE1 GET1 POST1 PUT

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 Issues 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 2 paths, the API surfaces 4 operations — 1 DELETE, 1 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Issues 4

Create, read, update, delete, and transition Jira issues.

POST
/issue
Jira Create Issue
createIssue 1 param body → 201400401403
GET
/issue/{issueIdOrKey}
Jira Get Issue
getIssue 5 params → 200401404
PUT
/issue/{issueIdOrKey}
Jira Edit Issue
editIssue 4 params body → 204400401403404
DELETE
/issue/{issueIdOrKey}
Jira Delete Issue
deleteIssue 2 params → 204400401403404

Schemas 36

The contract defines 36 schemas that model the data the API accepts and returns. The most detailed are IssueFields (27 properties), Worklog (10 properties), Version (10 properties), Comment (10 properties). Each schema is shown below with its type and property counts.

TransitionRef
object
A reference to a transition by ID.
1 property 1 required
Comment
object
A comment on an issue.
10 properties
Component
object
A project component.
9 properties
IssueBean
object
A Jira issue with all fields and metadata.
10 properties
IssueUpdateRequest
object
Request body for editing an issue.
5 properties
ChangeItem
object
An individual field change within a changelog entry.
7 properties
Watches
object
The watchers of an issue.
3 properties
IssueLinkType
object
The type of link between issues.
5 properties
Attachment
object
An attachment on an issue.
9 properties
IssueFields
object
The fields of a Jira issue.
27 properties
StatusCategory
object
A status category in Jira.
5 properties
EntityProperty
object
An entity property (key-value pair).
2 properties
StatusDetails
object
A status in Jira.
6 properties
Priority
object
An issue priority.
6 properties
AvatarUrls
object
Avatar URLs in multiple sizes.
4 properties
IssueTypeDetails
object
Details of an issue type.
9 properties
AtlassianDocumentFormat
object
Atlassian Document Format (ADF) representation of rich text content. ADF is a JSON-based format used in Jira Cloud REST API v3 for description, comment, and ot…
3 properties 3 required
UserDetails
object
A Jira user.
8 properties
Worklog
object
A worklog entry.
10 properties
Visibility
object
The visibility restrictions for a comment.
3 properties
Votes
object
The votes for an issue.
3 properties
Transition
object
A workflow transition.
8 properties
CreatedIssue
object
Details of a newly created issue.
4 properties
Scope
object
The scope of the issue type (project or global).
2 properties
Changelog
object
A paginated list of changelogs.
4 properties
Version
object
A project version.
10 properties
ErrorCollection
object
Error details returned by the API.
3 properties
PageOfComments
object
A paginated list of comments.
4 properties
ChangeHistory
object
A changelog entry.
4 properties
IssueCreateRequest
object
Request body for creating an issue.
5 properties 1 required
Resolution
object
An issue resolution.
4 properties
IssueRef
object
A reference to an issue.
4 properties
PageOfWorklogs
object
A paginated list of worklogs.
4 properties
IssueLink
object
A link between issues.
5 properties
ProjectRef
object
A reference to a Jira project.
6 properties
FieldUpdateOperation
object
An operation to perform on a field value.
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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