Search code examples
jirajira-rest-apijira-agile

How to get all sprints in project using JIRA REST API


Is there anything something like "https://www.example.com/jira/rest/agile/1.0/sprint?project=XYZ", to retrieve all the sprints in a JIRA Software project.

The JIRA platform API can retrieve projects info and the JIRA Software API can retrieve sprints for a given board. But I need sprints for any given project (combination) or at least boards for a given software project so that I can retrieve sprints in those boards later.


Solution

  • You can do it but with two resources:

    • First you can get all the scrum boards of the project with this:

    https://docs.atlassian.com/jira-software/REST/cloud/#agile/1.0/board-getAllBoards

    • Use the query parameters projectKeyOrId and type to filter them.

    • Iterate all the elements and use the url below with the id of each board to get its sprints:

    https://docs.atlassian.com/jira-software/REST/cloud/#agile/1.0/board/{boardId}/sprint-getAllSprints