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

Apis related to sprints

Jira Sprint API is one of 132 APIs that Jira publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Sprint. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and an API reference.

This API exposes 13 operations across 7 paths, and defines 5 schemas. It is described by OpenAPI 3.2.0, at version 1001.0.0.

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

13 operations 7 paths 5 schemas 2 DELETE5 GET4 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 2

Jira Sprint 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 13

Across 7 paths, the API surfaces 13 operations — 2 DELETE, 5 GET, 4 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

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

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are IssueBean (15 properties), SoftwareIssueResults (7 properties), LinkGroup (6 properties), JsonTypeBean (6 properties). Each schema is shown below with its type and property counts.

JsonTypeBean
object
The schema of a field.
6 properties 1 required
SoftwareIssueResults
object
The result of an issue search in Jira Software APIs.
7 properties
IssueBean
object
Details about an issue.
15 properties
Operations
object
Details of the operations that can be performed on the issue.
1 property
LinkGroup
object
Details a link group, which defines issue operations.
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

jira-sprint-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
Jira Projects API
Where this information came from

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