Jira

Jira Sprint API

Apis related to sprints

GitHub OpenAPI

Operations 13

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /rest/agile/1.0/sprint Create a future sprint on a board · Create sprint #
Ask an LLM
“How do I create a new sprint on my Jira board?”
“Can I set a sprint goal and dates when creating it?”
Tell an agent
Create sprint {name} on board {originBoardId}.
Create sprint {name} on board {originBoardId} with goal {goal} from {startDate} to {endDate}.
DELETE /rest/agile/1.0/sprint/{sprintId} Delete a sprint · Delete sprint #
Ask an LLM
“What happens to open issues when I delete a sprint?”
“How do I remove a sprint I created by mistake?”
Tell an agent destructive · confirm first
Delete sprint {sprintId}.
Remove sprint {sprintId} and send its open issues to the backlog.
GET /rest/agile/1.0/sprint/{sprintId} Get a sprint's details · Get sprint #
Ask an LLM
“What are the dates, state and goal of a particular sprint?”
“How do I look up a sprint by its ID?”
Tell an agent
Show sprint {sprintId}.
Get the goal and dates of sprint {sprintId}.
POST /rest/agile/1.0/sprint/{sprintId} Change selected fields of a sprint · Partially update sprint #
Ask an LLM
“Can I change just a sprint's goal without touching its other fields?”
“How do I close an active sprint by updating only its state?”
Tell an agent
Set the goal of sprint {sprintId} to {goal}, leaving other fields alone.
Change only the state of sprint {sprintId} to {state}.
PUT /rest/agile/1.0/sprint/{sprintId} Replace all fields of a sprint · Update sprint #
Ask an LLM
“How do I do a full update of a sprint where missing fields get cleared?”
“Can I start a sprint by setting its state to active with a full update?”
Tell an agent
Fully replace sprint {sprintId} with name {name}, state {state}, start {startDate} and end {endDate}.
Overwrite every field of sprint {sprintId} so only {name} and {goal} remain set.
GET /rest/agile/1.0/sprint/{sprintId}/issue List issues in a sprint · Get issues for sprint #
Ask an LLM
“Which issues are in the current sprint, ordered by rank?”
“Can I filter a sprint's issues with JQL?”
Tell an agent
List the issues in sprint {sprintId}.
Show issues in sprint {sprintId} matching {jql}.
POST /rest/agile/1.0/sprint/{sprintId}/issue Move issues into a sprint · Move issues to sprint and rank #
Ask an LLM
“How do I pull issues from the backlog into an active sprint?”
“How many issues can I move into a sprint in one go?”
Tell an agent
Move issues {issues} into sprint {sprintId}.
Add {issues} to sprint {sprintId} ranked after {rankAfterIssue}.
GET /rest/software/1.0/sprint/{sprintId}/issue List sprint issues with token paging · Get issues for sprint (enhanced) #
Ask an LLM
“Is there a sprint issue listing that pages with a nextPageToken instead of startAt?”
“Can I get a sprint's issues with reconciled search results for recently changed issues?”
Tell an agent
List issues in sprint {sprintId} using the enhanced token-paged endpoint.
Get the next page of sprint {sprintId} issues with token {nextPageToken}.
GET /rest/agile/1.0/sprint/{sprintId}/properties List property keys stored on a sprint · Get properties keys #
Ask an LLM
“What custom properties have been stored against a sprint?”
“How do I see the keys of a sprint's entity properties?”
Tell an agent
List the property keys on sprint {sprintId}.
Show which custom data keys sprint {sprintId} holds.
DELETE /rest/agile/1.0/sprint/{sprintId}/properties/{propertyKey} Remove a property from a sprint · Delete property #
Ask an LLM
“How do I delete a custom property from a sprint?”
“What permission do I need to remove sprint property data?”
Tell an agent destructive · confirm first
Delete property {propertyKey} from sprint {sprintId}.
Clear the {propertyKey} data on sprint {sprintId}.
GET /rest/agile/1.0/sprint/{sprintId}/properties/{propertyKey} Read a sprint property value · Get property #
Ask an LLM
“How do I read the value of a custom property saved on a sprint?”
“Can I fetch one sprint property by its key?”
Tell an agent
Get property {propertyKey} from sprint {sprintId}.
Read the {propertyKey} value stored on sprint {sprintId}.
PUT /rest/agile/1.0/sprint/{sprintId}/properties/{propertyKey} Store a custom property on a sprint · Set property #
Ask an LLM
“Can I store my own custom data against a sprint?”
“How do I set or overwrite a sprint property value?”
Tell an agent
Set property {propertyKey} on sprint {sprintId}.
Save custom data under {propertyKey} for sprint {sprintId}.
POST /rest/agile/1.0/sprint/{sprintId}/swap Swap the order of two sprints · Swap sprint #
Ask an LLM
“How do I swap the position of two sprints on a board?”
“Can I reorder sprints by exchanging one with another?”
Tell an agent
Swap sprint {sprintId} with sprint {sprintToSwapWith}.
Exchange positions of sprints {sprintId} and {sprintToSwapWith}.

Documentation

📖
Documentation
https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/
📖
Authentication
https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#authentication
📖
Documentation
https://developer.atlassian.com/cloud/jira/software/rest/intro/
📖
Documentation
https://developer.atlassian.com/cloud/jira/service-desk/rest/intro/
📖
APIReference
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/jira/refs/heads/main/openapi/jira-sprint-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/jira:jira-sprint-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

jira-sprint-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  contact:
    url: https://getsupport.atlassian.com
  description: Jira Software Cloud REST API documentation
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  termsOfService: http://atlassian.com/terms/
  title: Jira Software Cloud Sprint API
  version: 1001.0.0
servers:
- url: https://your-domain.atlassian.net
tags:


# --- truncated at 32 KB (96 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/jira/refs/heads/main/openapi/jira-sprint-api-openapi.yml