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

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

Jira Issues 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 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 28 operations across 22 paths, and defines 103 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.

28 operations 22 paths 103 schemas 2 DELETE11 GET9 POST6 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 Issues 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 28

Across 22 paths, the API surfaces 28 operations — 2 DELETE, 11 GET, 9 POST, 6 PUT. Each is listed below with its method, path, parameters, and response codes.

Issues 28

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
POST
/rest/api/3/changelog/bulkfetch
Bulk fetch changelogs
getBulkChangelogs body → 200400
GET
/rest/api/3/events
Get events
getEvents → 200401403
POST
/rest/api/3/issue
Create issue
postRestApi3Issue 1 param body → 201400401403422
POST
/rest/api/3/issue/archive
Archive issue(s) by JQL
archiveIssuesAsync body → 202400401403412
PUT
/rest/api/3/issue/archive
Archive issue(s) by issue ID/key
archiveIssues body → 200400401403412
POST
/rest/api/3/issue/bulk
Bulk create issue
createIssues body → 201400401
POST
/rest/api/3/issue/bulkfetch
Bulk fetch issues
bulkFetchIssues body → 200400401
GET
/rest/api/3/issue/createmetadeprecated
Get create issue metadata
getCreateIssueMeta 5 params → 200401
GET
/rest/api/3/issue/createmeta/{projectIdOrKey}/issuetypes
Get create metadata issue types for a project
getCreateIssueMetaIssueTypes 3 params → 200400401
GET
/rest/api/3/issue/createmeta/{projectIdOrKey}/issuetypes/{issueTypeId}
Get create field metadata for a project and issue type id
getCreateIssueMetaIssueTypeId 4 params → 200400401
GET
/rest/api/3/issue/limit/adf/report
Get issue adf limit report
getIssueAdfLimitReport 2 params → 200400401403
GET
/rest/api/3/issue/limit/report
Get issue limit report
getIssueLimitReport 1 param → 200401403
PUT
/rest/api/3/issue/unarchive
Unarchive issue(s) by issue keys/ID
unarchiveIssues body → 200400401403412
DELETE
/rest/api/3/issue/{issueIdOrKey}
Delete issue
deleteRestApi3IssueByIssueIdOrKey 2 params → 204400401403404
GET
/rest/api/3/issue/{issueIdOrKey}
Get issue
getRestApi3IssueByIssueIdOrKey 7 params → 200401404
PUT
/rest/api/3/issue/{issueIdOrKey}
Edit issue
putRestApi3IssueByIssueIdOrKey 6 params body → 200204400401403404409422
PUT
/rest/api/3/issue/{issueIdOrKey}/assignee
Assign issue
assignIssue 1 param body → 204400403404
GET
/rest/api/3/issue/{issueIdOrKey}/changelog
Get changelogs
getChangeLogs 3 params → 200404
POST
/rest/api/3/issue/{issueIdOrKey}/changelog/list
Get changelogs by IDs
getChangeLogsByIds 1 param body → 200400404
GET
/rest/api/3/issue/{issueIdOrKey}/editmeta
Get edit issue metadata
getEditIssueMeta 3 params → 200401403404
POST
/rest/api/3/issue/{issueIdOrKey}/notify
Send notification for issue
notify 1 param body → 204400403404
GET
/rest/api/3/issue/{issueIdOrKey}/transitions
Get transitions
getTransitions 6 params → 200401404
POST
/rest/api/3/issue/{issueIdOrKey}/transitions
Transition issue
doTransition 1 param body → 204400401404409413422
PUT
/rest/api/3/issues/archive/export
Export archived issue(s)
exportArchivedIssues body → 202400401403412

Schemas 103

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

Version
object
A project version.
10 properties
Component
object
A project component.
9 properties
IssueTypeDetails
object
Details of an issue type.
9 properties
EntityProperty
object
An entity property (key-value pair).
2 properties
ProjectRef
object
A reference to a Jira project.
6 properties
ErrorCollection
object
Error details returned by the API.
3 properties
TransitionRef
object
A reference to a transition by ID.
1 property 1 required
IssueLinkType
object
The type of link between issues.
5 properties
Votes
object
The votes for an issue.
3 properties
StatusCategory
object
A status category in Jira.
5 properties
ChangeItem
object
An individual field change within a changelog entry.
7 properties
IssueLink
object
A link between issues.
5 properties
StatusDetails
object
A status in Jira.
6 properties
CreatedIssue
object
Details of a newly created issue.
4 properties
Watches
object
The watchers of an issue.
3 properties
IssueUpdateRequest
object
Request body for editing an issue.
5 properties
IssueFields
object
The fields of a Jira issue.
27 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
Attachment
object
An attachment on an issue.
9 properties
FieldUpdateOperation
object
An operation to perform on a field value.
5 properties
Changelog
object
A paginated list of changelogs.
4 properties
PageOfWorklogs
object
A paginated list of worklogs.
4 properties
Scope
object
The scope of the issue type (project or global).
2 properties
Visibility
object
The visibility restrictions for a comment.
3 properties
Transition
object
A workflow transition.
8 properties
IssueRef
object
A reference to an issue.
4 properties
Worklog
object
A worklog entry.
10 properties
AvatarUrls
object
Avatar URLs in multiple sizes.
4 properties
IssueCreateRequest
object
Request body for creating an issue.
5 properties 1 required
UserDetails
object
A Jira user.
8 properties
Priority
object
An issue priority.
6 properties
Resolution
object
An issue resolution.
4 properties
PageOfComments
object
A paginated list of comments.
4 properties
IssueBean
object
A Jira issue with all fields and metadata.
10 properties
ChangeHistory
object
A changelog entry.
4 properties
Comment
object
A comment on an issue.
10 properties
BulkIssueResults
object
The list of requested issues & fields.
2 properties
SimpleListWrapperApplicationRole
object
5 properties
JsonTypeBean
object
The schema of a field.
6 properties 1 required
IssueLimitReportResponseBean
object
4 properties
BulkChangelogResponseBean
object
A page of changelogs which is designed to handle multiple issues
2 properties
ArchivedIssuesFilterRequest
object
Details of a filter for exporting archived issues.
5 properties
BulkChangelogRequestBean
object
Request bean for bulk changelog retrieval
4 properties 1 required
DateRangeFilterRequest
object
List issues archived within a specified date range.
2 properties 2 required
ListWrapperCallbackGroupName
object
FieldMetadata
object
The metadata describing an issue field.
10 properties 5 required
Operations
object
Details of the operations that can be performed on the issue.
1 property
EntityProperty_2
object
An entity property, for more information see [Entity properties](https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/).
2 properties
CreatedIssues
object
Details about the issues created and the errors for requests that failed.
2 properties
IssueTransition
object
Details of an issue transition.
11 properties
ErrorCollection_2
object
Error messages from an operation.
3 properties
SimpleLink
object
Details about the operations available in this version.
7 properties
ArchiveIssueAsyncRequest
object
1 property
ChangeDetails
object
A change item.
7 properties
StatusCategory_2
object
A status category.
5 properties
FieldCreateMetadata
object
The metadata describing an issue field for createmeta.
11 properties 6 required
Errors
object
5 properties
Transitions
object
List of issue transitions.
2 properties
RestrictedPermission
object
Details of the permission.
2 properties
StatusDetails_2
object
A status.
7 properties
SimpleListWrapperGroupName
object
5 properties
NotificationRecipients
object
Details of the users and groups to receive the notification.
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
IssueUpdateDetails
object
Details of an issue update request.
5 properties
NestedResponse
object
3 properties
CreatedIssue_2
object
Details about a created issue or subtask.
5 properties
IssueChangeLog
object
List of changelogs that belong to single issue
2 properties
BulkFetchIssueRequestBean
object
5 properties 1 required
IssueCreateMetadata
object
The wrapper for the issue creation metadata for a list of projects.
2 properties
WarningCollection
object
1 property
Notification
object
Details about a notification.
5 properties
FieldUpdateOperation_2
object
Details of an operation to perform on a field.
5 properties
ExportArchivedIssuesTaskProgressResponse
object
The response for status request for a running/completed export task.
6 properties
IssueUpdateMetadata
object
A list of editable field details.
1 property
IssueArchivalSyncRequest
object
List of Issue Ids Or Keys that are to be archived or unarchived
1 property
PageBeanChangelog
object
A page of items.
7 properties
ProjectIssueCreateMetadata
object
Details of the issue creation metadata for a project.
7 properties
Changelog_2
object
A log of changes made to issue fields. Changelogs related to workflow associations are currently being deprecated.
5 properties
Error
object
3 properties
ListWrapperCallbackApplicationRole
object
IssueChangelogIds
object
A list of changelog IDs.
1 property 1 required
AvatarUrlsBean
object
4 properties
LinkGroup
object
Details a link group, which defines issue operations.
6 properties
IssuesUpdateBean
object
1 property
IssueError
object
Describes the error that occurred when retrieving data for a particular issue.
2 properties
IncludedFields
object
3 properties
IssueArchivalSyncResponse
object
Number of archived/unarchived issues and list of errors that occurred during the action, if any.
2 properties
IssueTypeIssueCreateMetadata
object
Details of the issue creation metadata for an issue type.
12 properties
NotificationRecipientsRestrictions
object
Details of the group membership or permissions needed to receive the notification.
3 properties
PageOfCreateMetaIssueTypeWithField
object
A page of CreateMetaIssueType with Field.
5 properties
GroupName
object
Details about a group.
3 properties
HistoryMetadata
object
Details of issue history metadata.
11 properties
UpdatedProjectCategory
object
A project category.
4 properties
IssueEvent
object
Details about an issue event.
2 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
ApplicationRole
object
Details of an application role.
14 properties
ProjectDetails
object
Details about a project.
8 properties
BulkOperationErrorResult
object
3 properties
IssueBean_2
object
Details about an issue.
15 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
PageOfChangelogs
object
A page of changelogs.
4 properties
PageOfCreateMetaIssueTypes
object
A page of CreateMetaIssueTypes.
5 properties
HistoryMetadataParticipant
object
Details of user or system associated with a issue history metadata item.
6 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
Atlassian Remote MCP Server
Where this information came from

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