How to get current sprint in board with REST API?

[Seikyo Cho]

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?

[Bill Sheboy · Accepted solution]

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

[Seikyo Cho]

Hi @Bill Sheboy 

Thank you. In this way I got all the sprints in board 1. From the state == active I can get the current ongoing sprint.

By the way, how to get all issues in one sprint?

[Bill Sheboy]

To get the issues in the sprint, you may use the specific function for that or the issue search with JQL:

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

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-search/#api-rest-api-3-search-get

[Seikyo Cho]

Thank you @Bill Sheboy .

It works for me!

[Kalyan Sattaluri]

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.

[Seikyo Cho]

Hello @Kalyan Sattaluri 

Thank you.

Do you mean this sprint item?

I hover over it but didn't find any information.