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 Software Cloud API

The first-party Jira Software (Agile) REST API at /rest/agile/1.0 — 105 operations covering boards, sprints, epics, backlogs, versions, and the development-information surface for builds, deployments, feature flags and remote links. Harvested verbatim from Atlassian.

Jira Software Cloud API is one of 12 APIs that Atlassian Jira publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Agile, Scrum, and Kanban. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 105 operations across 78 paths, organized into 13 resource areas, and defines 66 schemas. It is described by OpenAPI 3.0.1, at version 1001.0.0.

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

105 operations 78 paths 66 schemas 24 DELETE53 GET21 POST7 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1001.0.0
Base URL
https://your-domain.atlassian.net
Authentication
OAuth 2.0, HTTP Basic
License
Terms of Service
Resource Areas
13

Authentication & Security 2

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

  • OAuth2 — OAuth2 scopes for Jira
  • basicAuth — Basic authentication using email and API token

Paths & Operations 105

Across 78 paths, the API surfaces 105 operations — 24 DELETE, 53 GET, 21 POST, 7 PUT. They span 13 resource areas, including Backlog, Board, Epic, Issue, Sprint, Development Information, Feature Flags, Deployments, and 5 more. Each is listed below with its method, path, parameters, and response codes.

Backlog 2

Apis related to the backlog

POST
/rest/agile/1.0/backlog/issue
Move issues to backlog
moveIssuesToBacklog body → 204400401403404
POST
/rest/agile/1.0/backlog/{boardId}/issue
Move issues to backlog for board
moveIssuesToBacklogForBoard 1 param body → 204207400401403404
Board 33

Apis related to boards

GET
/rest/agile/1.0/board
Get all boards
getAllBoards 13 params → 200400401403
POST
/rest/agile/1.0/board
Create board
createBoard body → 201400401403
GET
/rest/agile/1.0/board/filter/{filterId}
Get board by filter id
getBoardByFilterId 3 params → 200400401
DELETE
/rest/agile/1.0/board/{boardId}
Delete board
deleteBoard 1 param → 204403404
GET
/rest/agile/1.0/board/{boardId}
Get board
getBoard 1 param → 200400401403404
GET
/rest/agile/1.0/board/{boardId}/backlogdeprecated
Get issues for backlog
getIssuesForBacklog 7 params → 200400401403404
GET
/rest/software/1.0/board/{boardId}/backlog
Get issues for backlog (enhanced)
getIssuesForBacklogJSIS 8 params → 200400401403404
GET
/rest/software/1.0/board/{boardId}/backlog/approximate-count
Get approximate issue count for backlog
getApproximateIssueCountForBacklog 2 params → 200400401403404
GET
/rest/agile/1.0/board/{boardId}/configuration
Get configuration
getConfiguration 1 param → 200401403404
GET
/rest/agile/1.0/board/{boardId}/epic
Get epics
getEpics 4 params → 200400401403404
GET
/rest/agile/1.0/board/{boardId}/epic/none/issuedeprecated
Get issues without epic for board
getIssuesWithoutEpicForBoard 7 params → 200400401403404
GET
/rest/software/1.0/board/{boardId}/epic/none/issue
Get issues without epic for board (enhanced)
getIssuesWithoutEpicForBoardJSIS 8 params → 200400401403404
GET
/rest/agile/1.0/board/{boardId}/epic/{epicId}/issuedeprecated
Get board issues for epic
getBoardIssuesForEpic 8 params → 200400401403404
GET
/rest/software/1.0/board/{boardId}/epic/{epicId}/issue
Get board issues for epic (enhanced)
getBoardIssuesForEpicJSIS 9 params → 200400401403404
GET
/rest/agile/1.0/board/{boardId}/features
Get features for board
getFeaturesForBoard 1 param → 200
PUT
/rest/agile/1.0/board/{boardId}/features
Toggle features
toggleFeatures 1 param body → 200
GET
/rest/agile/1.0/board/{boardId}/issuedeprecated
Get issues for board
getIssuesForBoard 7 params → 200400401403404
POST
/rest/agile/1.0/board/{boardId}/issue
Move issues to board
moveIssuesToBoard 1 param body → 204207400401403
GET
/rest/software/1.0/board/{boardId}/issue
Get issues for board (enhanced)
getIssuesForBoardJSIS 8 params → 200400401403404
GET
/rest/software/1.0/board/{boardId}/issue/approximate-count
Get approximate issue count for board
getApproximateIssueCountForBoard 2 params → 200400401403404
GET
/rest/agile/1.0/board/{boardId}/project
Get projects
getProjects 3 params → 200400401403404
GET
/rest/agile/1.0/board/{boardId}/project/full
Get projects full
getProjectsFull 1 param → 200400401403404
GET
/rest/agile/1.0/board/{boardId}/properties
Get board property keys
getBoardPropertyKeys 1 param → 200400401404
DELETE
/rest/agile/1.0/board/{boardId}/properties/{propertyKey}
Delete board property
deleteBoardProperty 2 params → 204400401404
GET
/rest/agile/1.0/board/{boardId}/properties/{propertyKey}
Get board property
getBoardProperty 2 params → 200400401404
PUT
/rest/agile/1.0/board/{boardId}/properties/{propertyKey}
Set board property
setBoardProperty 2 params body → 200201400401404
GET
/rest/agile/1.0/board/{boardId}/quickfilter
Get all quick filters
getAllQuickFilters 3 params → 200400401403404
GET
/rest/agile/1.0/board/{boardId}/quickfilter/{quickFilterId}
Get quick filter
getQuickFilter 2 params → 200401403404
GET
/rest/agile/1.0/board/{boardId}/reports
Get reports for board
getReportsForBoard 1 param → 200
GET
/rest/agile/1.0/board/{boardId}/sprint
Get all sprints
getAllSprints 4 params → 200400401403404
GET
/rest/agile/1.0/board/{boardId}/sprint/{sprintId}/issuedeprecated
Get board issues for sprint
getBoardIssuesForSprint 8 params → 200400401403404
GET
/rest/software/1.0/board/{boardId}/sprint/{sprintId}/issue
Get board issues for sprint (enhanced)
getBoardIssuesForSprintJSIS 9 params → 200400401403404
GET
/rest/agile/1.0/board/{boardId}/version
Get all versions
getAllVersions 4 params → 200400401403404
Epic 9

Apis related to epics

GET
/rest/agile/1.0/epic/none/issuedeprecated
Get issues without epic
getIssuesWithoutEpic 6 params → 200400401403
POST
/rest/agile/1.0/epic/none/issue
Remove issues from epic
removeIssuesFromEpic body → 204400401403404
GET
/rest/software/1.0/epic/none/issue
Get issues without epic (enhanced)
getIssuesWithoutEpicJSIS 7 params → 200400401403
GET
/rest/agile/1.0/epic/{epicIdOrKey}
Get epic
getEpic 1 param → 200401403404
POST
/rest/agile/1.0/epic/{epicIdOrKey}
Partially update epic
partiallyUpdateEpic 1 param body → 200400401403404
GET
/rest/agile/1.0/epic/{epicIdOrKey}/issuedeprecated
Get issues for epic
getIssuesForEpic 7 params → 200400401403404
POST
/rest/agile/1.0/epic/{epicIdOrKey}/issue
Move issues to epic
moveIssuesToEpic 1 param body → 204400401403404
GET
/rest/software/1.0/epic/{epicIdOrKey}/issue
Get issues for epic (enhanced)
getIssuesForEpicJSIS 8 params → 200400401403404
PUT
/rest/agile/1.0/epic/{epicIdOrKey}/rank
Rank epics
rankEpics 1 param body → 204400401403404
Issue 4

Apis related to issues

PUT
/rest/agile/1.0/issue/rank
Rank issues
rankIssues body → 204207400401403
GET
/rest/agile/1.0/issue/{issueIdOrKey}
Get issue
getIssue 4 params → 200400401403404
GET
/rest/agile/1.0/issue/{issueIdOrKey}/estimation
Get issue estimation for board
getIssueEstimationForBoard 2 params → 200400401403404
PUT
/rest/agile/1.0/issue/{issueIdOrKey}/estimation
Estimate issue for board
estimateIssueForBoard 2 params body → 200400401403404
Sprint 13

Apis related to sprints

POST
/rest/agile/1.0/sprint
Create sprint
createSprint body → 201400401403404
DELETE
/rest/agile/1.0/sprint/{sprintId}
Delete sprint
deleteSprint 1 param → 204401403404
GET
/rest/agile/1.0/sprint/{sprintId}
Get sprint
getSprint 1 param → 200401403404
POST
/rest/agile/1.0/sprint/{sprintId}
Partially update sprint
partiallyUpdateSprint 1 param body → 200400401403404
PUT
/rest/agile/1.0/sprint/{sprintId}
Update sprint
updateSprint 1 param body → 200400401403404
GET
/rest/agile/1.0/sprint/{sprintId}/issuedeprecated
Get issues for sprint
getIssuesForSprint 7 params → 200401403404
POST
/rest/agile/1.0/sprint/{sprintId}/issue
Move issues to sprint and rank
moveIssuesToSprintAndRank 1 param body → 204400401403404
GET
/rest/software/1.0/sprint/{sprintId}/issue
Get issues for sprint (enhanced)
getIssuesForSprintJSIS 8 params → 200400401403404
GET
/rest/agile/1.0/sprint/{sprintId}/properties
Get properties keys
getPropertiesKeys 1 param → 200400401403404
DELETE
/rest/agile/1.0/sprint/{sprintId}/properties/{propertyKey}
Delete property
deleteProperty 2 params → 204400401403404
GET
/rest/agile/1.0/sprint/{sprintId}/properties/{propertyKey}
Get property
getProperty 2 params → 200400401403404
PUT
/rest/agile/1.0/sprint/{sprintId}/properties/{propertyKey}
Set property
setProperty 2 params body → 200201400401403404
POST
/rest/agile/1.0/sprint/{sprintId}/swap
Swap sprint
swapSprint 1 param body → 204401403404
Development Information 6

APIs related to integrating development information (commits, branches and pull requests) with Jira. These APIs are available to Atlassian Connect apps and on-premise integrations…

POST
/rest/devinfo/0.10/bulk
Store development information
storeDevelopmentInformation 1 param body → 202400401403413429500503
GET
/rest/devinfo/0.10/repository/{repositoryId}
Get repository
getRepository 2 params → 200401403404429500503
DELETE
/rest/devinfo/0.10/repository/{repositoryId}
Delete repository
deleteRepository 3 params → 202401403429500503
DELETE
/rest/devinfo/0.10/bulkByProperties
Delete development information by properties
deleteByProperties 2 params → 202400401403429500503
GET
/rest/devinfo/0.10/existsByProperties
Check if data exists for the supplied properties
existsByProperties 2 params → 200400401403429500503
DELETE
/rest/devinfo/0.10/repository/{repositoryId}/{entityType}/{entityId}
Delete development information entity
deleteEntity 5 params → 202400401403429500503
Feature Flags 4

APIs related to integrating feature flags with Jira Software. These APIs are available to Atlassian Connect apps. To use these APIs you must have the jiraFeatureFlagInfoProvider m…

POST
/rest/featureflags/0.1/bulk
Submit Feature Flag data
submitFeatureFlags 1 param body → 202400401403413429503default
DELETE
/rest/featureflags/0.1/bulkByProperties
Delete Feature Flags by Property
deleteFeatureFlagsByProperty 2 params → 202400401403429503default
GET
/rest/featureflags/0.1/flag/{featureFlagId}
Get a Feature Flag by ID
getFeatureFlagById 2 params → 200401403404429503default
DELETE
/rest/featureflags/0.1/flag/{featureFlagId}
Delete a Feature Flag by ID
deleteFeatureFlagById 3 params → 202401403429503default
Deployments 5

APIs related to integrating deployment data with Jira Software. These APIs are available to Atlassian Connect apps. To use these APIs you must have the jiraDeploymentInfoProvider…

POST
/rest/deployments/0.1/bulk
Submit deployment data
submitDeployments 1 param body → 202400401403413429503default
DELETE
/rest/deployments/0.1/bulkByProperties
Delete deployments by Property
deleteDeploymentsByProperty 2 params → 202400401403429503default
GET
/rest/deployments/0.1/pipelines/{pipelineId}/environments/{environmentId}/deployments/{deploymentSequenceNumber}
Get a deployment by key
getDeploymentByKey 4 params → 200401403404429503default
DELETE
/rest/deployments/0.1/pipelines/{pipelineId}/environments/{environmentId}/deployments/{deploymentSequenceNumber}
Delete a deployment by key
deleteDeploymentByKey 5 params → 202401403429503default
GET
/rest/deployments/0.1/pipelines/{pipelineId}/environments/{environmentId}/deployments/{deploymentSequenceNumber}/gating-status
Get deployment gating status by key
getDeploymentGatingStatusByKey 3 params → 200401403404429503default
Builds 4

APIs related to integrating build data with Jira Software. These APIs are available to Atlassian Connect apps. To use these APIs you must have the jiraBuildInfoProvider module in…

POST
/rest/builds/0.1/bulk
Submit build data
submitBuilds 1 param body → 202400401403413429503default
DELETE
/rest/builds/0.1/bulkByProperties
Delete builds by Property
deleteBuildsByProperty 2 params → 202400401403429503default
GET
/rest/builds/0.1/pipelines/{pipelineId}/builds/{buildNumber}
Get a build by key
getBuildByKey 3 params → 200401403404429503default
DELETE
/rest/builds/0.1/pipelines/{pipelineId}/builds/{buildNumber}
Delete a build by key
deleteBuildByKey 4 params → 202401403429503default
Remote Links 4

APIs related to integrating remote link data with Jira Software. These APIs are available to Atlassian Connect apps. To use these APIs you must have the jiraRemoteLinkInfoProvider…

POST
/rest/remotelinks/1.0/bulk
Submit Remote Link data
submitRemoteLinks 1 param body → 202400401403413429503default
DELETE
/rest/remotelinks/1.0/bulkByProperties
Delete Remote Links by Property
deleteRemoteLinksByProperty 3 params → 202400401403429503default
GET
/rest/remotelinks/1.0/remotelink/{remoteLinkId}
Get a Remote Link by ID
getRemoteLinkById 2 params → 200401403404429503default
DELETE
/rest/remotelinks/1.0/remotelink/{remoteLinkId}
Delete a Remote Link by ID
deleteRemoteLinkById 3 params → 202401403429503default
Security Information 8

Send security information to Jira Software and enable your teams to turn unplanned vulnerabilities into planned and tracked work. Security is everyone's responsibility, and the se…

POST
/rest/security/1.0/linkedWorkspaces/bulk
Submit Security Workspaces to link
submitWorkspaces 1 param body → 202400401403413429503default
DELETE
/rest/security/1.0/linkedWorkspaces/bulk
Delete linked Security Workspaces
deleteLinkedWorkspaces 1 param → 202400401403429503default
GET
/rest/security/1.0/linkedWorkspaces
Get linked Security Workspaces
getLinkedWorkspaces 1 param → 200401403404429503default
GET
/rest/security/1.0/linkedWorkspaces/{workspaceId}
Get a linked Security Workspace by ID
getLinkedWorkspaceById 2 params → 200401403404429503default
POST
/rest/security/1.0/bulk
Submit Vulnerability data
submitVulnerabilities 1 param body → 202400401403413429503default
DELETE
/rest/security/1.0/bulkByProperties
Delete Vulnerabilities by Property
deleteVulnerabilitiesByProperty 1 param → 202400401403429503default
GET
/rest/security/1.0/vulnerability/{vulnerabilityId}
Get a Vulnerability by ID
getVulnerabilityById 2 params → 200401403404429503default
DELETE
/rest/security/1.0/vulnerability/{vulnerabilityId}
Delete a Vulnerability by ID
deleteVulnerabilityById 2 params → 202401403429503default
Operations 9

APIs related to integrating Incident and Post-Incident Review (PIR) data with Jira Software. These APIs are available to Atlassian Connect apps. To use these APIs you must have th…

POST
/rest/operations/1.0/linkedWorkspaces/bulk
Submit Operations Workspace Ids
submitOperationsWorkspaces 1 param body → 202400401403413429503default
DELETE
/rest/operations/1.0/linkedWorkspaces/bulk
Delete Operations Workpaces by Id
deleteWorkspaces 1 param → 202400401403429503default
GET
/rest/operations/1.0/linkedWorkspaces
Get all Operations Workspace IDs or a specific Operations Workspace by ID
getWorkspaces 1 param → 200401403404429503default
POST
/rest/operations/1.0/bulk
Submit Incident or Review data
submitEntity 1 param body → 202400401403413429503default
DELETE
/rest/operations/1.0/bulkByProperties
Delete Incidents or Review by Property
deleteEntityByProperty 1 param → 202400401403429503default
GET
/rest/operations/1.0/incidents/{incidentId}
Get a Incident by ID
getIncidentById 2 params → 200401403404429503default
DELETE
/rest/operations/1.0/incidents/{incidentId}
Delete a Incident by ID
deleteIncidentById 2 params → 202401403429503default
GET
/rest/operations/1.0/post-incident-reviews/{reviewId}
Get a Review by ID
getReviewById 2 params → 200401403404429503default
DELETE
/rest/operations/1.0/post-incident-reviews/{reviewId}
Delete a Review by ID
deleteReviewById 2 params → 202401403429503default
DevOps Components 4

APIs related to integrating Dev Ops Components affected by Incident data with Jira Software. These APIs are available to Atlassian Connect apps. To use these APIs you must have th…

POST
/rest/devopscomponents/1.0/bulk
Submit DevOps Components
submitComponents 1 param body → 202400401403413429503default
DELETE
/rest/devopscomponents/1.0/bulkByProperties
Delete DevOps Components by Property
deleteComponentsByProperty 1 param → 202400401403429503default
GET
/rest/devopscomponents/1.0/devopscomponents/{componentId}
Get a Component by ID
getComponentById 2 params → 200401403404429503default
DELETE
/rest/devopscomponents/1.0/devopscomponents/{componentId}
Delete a Component by ID
deleteComponentById 2 params → 202401403429503default

Schemas 66

The contract defines 66 schemas that model the data the API accepts and returns. The most detailed are IssueBean (15 properties), FeatureBean (13 properties), IssueTransition (11 properties), HistoryMetadata (11 properties). Each schema is shown below with its type and property counts.

AvatarUrlsBean
object
4 properties
Board
object
Details about a board.
9 properties
BoardAdminsBean
object
The users and groups who own the board.
2 properties
BoardConfigBean
object
10 properties
BoardCreateBean
object
4 properties
BoardFilterBean
object
3 properties
BoardLocationBean
object
The container that the board is located in.
9 properties
ChangeDetails
object
A change item.
7 properties
Changelog
object
A log of changes made to issue fields. Changelogs related to workflow associations are currently being deprecated.
5 properties
ColorBean
object
1 property
ColumnBean
object
4 properties
ColumnConfigBean
object
2 properties
Entry
object
4 properties
EpicRankRequestBean
object
3 properties
EpicUpdateBean
object
4 properties
EstimationConfigBean
object
2 properties
EstimationConfigurationBean
object
3 properties
EstimationFieldBean
object
2 properties
FeatureBean
object
13 properties
FeatureResponseBean
object
1 property
FeatureToggleRequestBean
object
3 properties
FieldEditBean
object
1 property
FieldMetadata
object
The metadata describing an issue field.
10 properties 5 required
GroupBean
object
2 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
IncludedFields
object
3 properties
IssueAssignRequestBean
object
1 property
IssueBean
object
Details about an issue.
15 properties
IssueRankRequestBean
object
4 properties
IssueTransition
object
Details of an issue transition.
11 properties
IssueUpdateMetadata
object
A list of editable field details.
1 property
JsonTypeBean
object
The schema of a field.
6 properties 1 required
LinkGroup
object
Details a link group, which defines issue operations.
6 properties
LocationBean
object
2 properties
Operations
object
Details of the operations that can be performed on the issue.
1 property
PageBeanBoard
object
5 properties
PageBeanBoardFilterBean
object
5 properties
PageBeanQuickFilterBean
object
5 properties
PageOfChangelogs
object
A page of changelogs.
4 properties
PartialSuccessBean
object
1 property
ProjectDetails
object
Details about a project.
8 properties
QuickFilterBean
object
6 properties
RankingConfigBean
object
1 property
RelationBean
object
2 properties
ReportBean
object
ReportsResponseBean
object
1 property
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
SearchResults
object
The result of a JQL search.
8 properties
SimpleLink
object
Details about the operations available in this version.
7 properties
SprintBean
object
10 properties
SprintCreateBean
object
5 properties
SprintSwapBean
object
1 property
StatusCategory
object
A status category.
5 properties
StatusDetails
object
A status.
7 properties
StringList
object
SubqueryBean
object
1 property
UpdatedProjectCategory
object
A project category.
4 properties
UserBean
object
7 properties
UserBeanAvatarUrls
object
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
IssueIdOrKeysAssociation
object
An association type referencing issues in Jira.
2 properties 2 required
ServiceIdOrKeysAssociation
object
An association type referencing service ID or keys.
2 properties 2 required
EntityAssociation
object
An association type referencing another entity
2 properties 2 required
SoftwareIssueResults
object
The result of an issue search in Jira Software APIs.
7 properties
IssueCountBean
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

atlassian-jira-software-openapi.json Raw ↑

Other APIs Atlassian Jira publishes across the network.

Atlassian Jira Fields API
Atlassian Jira Issue Comments API
Atlassian Jira Issue Search API
Atlassian Jira Issue Transitions API
Atlassian Jira Issue Worklogs API
Atlassian Jira Issues API
Atlassian Jira Projects API
Atlassian Jira Users API
Atlassian Jira Cloud Platform REST API v3
Jira Service Management REST API
Atlassian Remote MCP Server
Where this information came from

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