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

Atlassian Issues API

The Issues API from Atlassian — 32 operation(s) for issues.

Atlassian Issues API is one of 183 APIs that Atlassian publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 17 JSON Schema definitions.

Tagged areas include Issues. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 17 JSON Schemas.

This API exposes 20 operations across 16 paths, and defines 60 schemas. It is described by OpenAPI 3.2.0, at version 1001.0.0-SNAPSHOT-67b5c6e5f3598d7ec1649016d026468ab2838a77.

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

20 operations 16 paths 60 schemas 1 DELETE8 GET6 POST5 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1001.0.0-SNAPSHOT-67b5c6e5f3598d7ec1649016d026468ab2838a77
Server
https://your-domain.atlassian.net
Authentication
OAuth 2.0, HTTP Basic
License
Terms of Service
Resource Areas
1

Authentication & Security 2

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

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

Paths & Operations 20

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

Issues 20

This resource represents Jira issues. Use it to: create or edit issues, individually or in bulk. retrieve metadata about the options for creating or editing issues. delete an issu…

GET
/rest/api/3/events
Atlassian Get Events
atlassianGetevents → 200401403
POST
/rest/api/3/issue
Atlassian Create Issue
atlassianCreateissue 1 param body → 201400401403422
POST
/rest/api/3/issue/archive
Atlassian Archive Issue S By Jql
atlassianArchiveissuesasync body → 202400401403412
PUT
/rest/api/3/issue/archive
Atlassian Archive Issue S By Issue Id Key
atlassianArchiveissues body → 200400401403412
POST
/rest/api/3/issue/bulk
Atlassian Bulk Create Issue
atlassianCreateissues body → 201400401
GET
/rest/api/3/issue/createmetadeprecated
Atlassian Get Create Issue Metadata
atlassianGetcreateissuemeta 5 params → 200401
GET
/rest/api/3/issue/createmeta/{projectIdOrKey}/issuetypes
Atlassian Get Create Metadata Issue Types For A Project
atlassianGetcreateissuemetaissuetypes 3 params → 200400401
GET
/rest/api/3/issue/createmeta/{projectIdOrKey}/issuetypes/{issueTypeId}
Atlassian Get Create Field Metadata For A Project And Issue Type Id
atlassianGetcreateissuemetaissuetypeid 4 params → 200400401
PUT
/rest/api/3/issue/unarchive
Atlassian Unarchive Issue S By Issue Keys Id
atlassianUnarchiveissues body → 200400401403412
DELETE
/rest/api/3/issue/{issueIdOrKey}
Atlassian Delete Issue
atlassianDeleteissue 2 params → 204400401403404
GET
/rest/api/3/issue/{issueIdOrKey}
Atlassian Get Issue
atlassianGetissue 6 params → 200401404
PUT
/rest/api/3/issue/{issueIdOrKey}
Atlassian Edit Issue
atlassianEditissue 6 params body → 200204400401403404409422
PUT
/rest/api/3/issue/{issueIdOrKey}/assignee
Atlassian Assign Issue
atlassianAssignissue 1 param body → 204400403404
GET
/rest/api/3/issue/{issueIdOrKey}/changelog
Atlassian Get Changelogs
atlassianGetchangelogs 3 params → 200404
POST
/rest/api/3/issue/{issueIdOrKey}/changelog/list
Atlassian Get Changelogs By Ids
atlassianGetchangelogsbyids 1 param body → 200400404
GET
/rest/api/3/issue/{issueIdOrKey}/editmeta
Atlassian Get Edit Issue Metadata
atlassianGeteditissuemeta 3 params → 200401403404
POST
/rest/api/3/issue/{issueIdOrKey}/notify
Atlassian Send Notification For Issue
atlassianNotify 1 param body → 204400403404
GET
/rest/api/3/issue/{issueIdOrKey}/transitions
Atlassian Get Transitions
atlassianGettransitions 6 params → 200401404
POST
/rest/api/3/issue/{issueIdOrKey}/transitions
Atlassian Transition Issue
atlassianDotransition 1 param body → 204400401404409422
PUT
/rest/api/3/issues/archive/export
Atlassian Export Archived Issue S
atlassianExportarchivedissues body → 202400401403412

Schemas 60

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

ExportArchivedIssuesTaskProgressResponse
object
The response for status request for a running/completed export task.
6 properties
DateRangeFilterRequest
object
List issues archived within a specified date range.
2 properties 2 required
Scope
object
The projects the item is associated with. Indicated for items associated with [next-gen projects](https://confluence.atlassian.com/x/loMyO).
2 properties
NestedResponse
object
3 properties
FieldMetadata
object
The metadata describing an issue field.
10 properties 5 required
IssueUpdateMetadata
object
A list of editable field details.
1 property
ArchiveIssueAsyncRequest
object
1 property
IssuesUpdateBean
object
1 property
UpdatedProjectCategory
object
A project category.
4 properties
IssueCreateMetadata
object
The wrapper for the issue creation metadata for a list of projects.
2 properties
ProjectIssueCreateMetadata
object
Details of the issue creation metadata for a project.
7 properties
IssueTransition
object
Details of an issue transition.
11 properties
BulkOperationErrorResult
object
3 properties
WarningCollection
object
1 property
PageBeanChangelog
object
A page of items.
7 properties
SimpleLink
object
Details about the operations available in this version.
7 properties
IssueEvent
object
Details about an issue event.
2 properties
Notification
object
Details about a notification.
5 properties
EntityProperty
object
An entity property, for more information see [Entity properties](https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/).
2 properties
Changelog
object
A log of changes made to issue fields. Changelogs related to workflow associations are currently being deprecated.
5 properties
CreatedIssues
object
Details about the issues created and the errors for requests that failed.
2 properties
Errors
object
4 properties
StatusDetails
object
A status.
7 properties
ErrorCollection
object
Error messages from an operation.
3 properties
Operations
object
Details of the operations that can be performed on the issue.
1 property
GroupName
object
Details about a group.
3 properties
IssueChangelogIds
object
A list of changelog IDs.
1 property 1 required
ArchivedIssuesFilterRequest
object
Details of a filter for exporting archived issues.
5 properties
SimpleListWrapperGroupName
object
5 properties
ListWrapperCallbackApplicationRole
object
PageOfCreateMetaIssueTypes
object
A page of CreateMetaIssueTypes.
5 properties
Error
object
3 properties
NotificationRecipients
object
Details of the users and groups to receive the notification.
7 properties
ChangeDetails
object
A change item.
7 properties
HistoryMetadata
object
Details of issue history metadata.
11 properties
HistoryMetadataParticipant
object
Details of user or system associated with a issue history metadata item.
6 properties
PageOfCreateMetaIssueTypeWithField
object
A page of CreateMetaIssueType with Field.
5 properties
IssueBean
object
Details about an issue.
15 properties
CreatedIssue
object
Details about a created issue or subtask.
5 properties
LinkGroup
object
Details a link group, which defines issue operations.
6 properties
FieldCreateMetadata
object
The metadata describing an issue field for createmeta.
11 properties 6 required
NotificationRecipientsRestrictions
object
Details of the group membership or permissions needed to receive the notification.
3 properties
ProjectDetails
object
Details about a project.
8 properties
JsonTypeBean
object
The schema of a field.
6 properties 1 required
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…
14 properties
ApplicationRole
object
Details of an application role.
14 properties
RestrictedPermission
object
Details of the permission.
2 properties
AvatarUrlsBean
object
4 properties
Transitions
object
List of issue transitions.
2 properties
IssueArchivalSyncResponse
object
Number of archived/unarchived issues and list of errors that occurred during the action, if any.
2 properties
StatusCategory
object
A status category.
5 properties
IssueArchivalSyncRequest
object
List of Issue Ids Or Keys that are to be archived or unarchived
1 property
PageOfChangelogs
object
A page of changelogs.
4 properties
UserDetails
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
ListWrapperCallbackGroupName
object
SimpleListWrapperApplicationRole
object
5 properties
IncludedFields
object
3 properties
FieldUpdateOperation
object
Details of an operation to perform on a field.
5 properties
IssueUpdateDetails
object
Details of an issue update request.
5 properties
IssueTypeIssueCreateMetadata
object
Details of the issue creation metadata for an issue type.
12 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

atlassian-issues-api-openapi.yml Raw ↑

Other APIs Atlassian publishes across the network.

Atlassian Jira Software Backlog API
Atlassian Jira Software Board API
Atlassian Jira Software Epic API
Atlassian Jira Software Sprint API
Atlassian Jira Software Development Information API
Atlassian Jira Software Feature Flags API
Atlassian Jira Software Deployments API
Atlassian Jira Software Builds API
Atlassian Jira Software Remote Links API
Atlassian Jira Software Security Information API
Atlassian Jira Service Management Customer API
Atlassian Jira Service Management Info API
Where this information came from

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