nav[aria-label="Primary Navigation"] { padding: 0; & ul { list-style: none; width: 100%; display: flex; flex-direction: row; justify-content: start; align-items: start; gap: 30px; padding: 0; & li { margin: 0; } & ul li { list-style: none; } } }

How to get current sprint in board with REST API?

Seikyo Cho_658chz

I have a Backlog as

The sprint 1 and sprint 2 are created by Create sprint API:

https://developer.atlassian.com/cloud/jira/software/rest/api-group-sprint/#api-rest-agile-1-0-sprint-post

The AW Board Sprint 1 is the default area.

When I click Start sprint button in sprint 1, it been copied to Board menu as

But when I get sprint with API like:

https://my-domain.atlassian.net/rest/agile/1.0/sprint/1

It returned

{
  "id": 1,
  "self": "https://my-domain.atlassian.net/rest/agile/1.0/sprint/1",
  "state": "future",
  "name": "AW Board Sprint 1",
  "createdDate": "2024-04-10T01:01:01.873Z",
  "originBoardId": 1,
  "goal": ""
}

These APIs returned error:

https://my-domain.atlassian.net/rest/agile/1.0/sprint/2
https://my-domain.atlassian.net/rest/agile/1.0/sprint/3

{
  "errorMessages": [
    "We could not find the sprint"
  ],
  "errors": {}
}

Why can't get the created 2 sprints by API? And which API can be used to get the current ongoing sprint in Board?

Accepted answers

Bill Sheboy

Hi @Seikyo Cho

You may get the specific sprint by id, as @Kalyan Sattaluri notes, or you may get all of the sprints for the board, filtering to the one(s) with the active state using the parameter:

https://developer.atlassian.com/cloud/jira/software/rest/api-group-board/#api-rest-agile-1-0-board-boardid-sprint-get

Kind regards,
Bill

All comments

Kalyan Sattaluri_iinm1n

Hello @Seikyo Cho

Are you sure you are passing the right sprint ID in your request call?

Open story AW-3, on the right hand pane where it shows sprint, hover over it, what is the ID of the sprint you see in the bottom left of your screen? Same goes with AW-4 story. Cross check the sprint ID for the 2 other sprints.

Bill Sheboy

Hi @Seikyo Cho

You may get the specific sprint by id, as @Kalyan Sattaluri notes, or you may get all of the sprints for the board, filtering to the one(s) with the active state using the parameter: