# Feature AGILE-72 - Sprints included in API (GET sprint and sprint on work package resource)

Project: Stream agile
Status: closed
URL: https://community.openproject.org/work_packages/AGILE-72

## Planning

| Attribute | Value |
| --- | --- |
| Date |  |
| Priority | Medium |
| Target versions | 17.3.0 |
| Sprint |  |
| Backlog bucket |  |
| Votes |  |
| List |  |
| Roadmap |  |
| Relevance |  |

## OPEN POINTS / FEEDBACK

_No work packages_

## Features and Chunks

| ID | Subject | Type | Status | Assignee | Target versions | Spent time |
| --- | --- | --- | --- | --- | --- | --- |
| AGILE-106 | Functionality - Sprints included in API | Implementation | closed |  | 17.3.0 |  |
| AGILE-107 | Documentation - Sprints included in API | Implementation | closed |  | 17.3.0 |  |

## Bugs and other work packages

_No work packages_

## Technical Details

| Attribute | Value |
| --- | --- |
| Module |  |
| Feature Flag |  |
| Requires doc change | No |
| Enterprise plan |  |

## Details

| Attribute | Value |
| --- | --- |
| Pull preview |  |
| Mockups |  |
| Accessibility | No |

## People

| Attribute | Value |
| --- | --- |
| Assignee |  |
| Accountable |  |
| Product manager |  |
| Developers | Jens Ulferts |
| Designer |  |
| Ordered by |  |
| Signed off by |  |
| Interest by |  |

## Estimates and progress

| Attribute | Value |
| --- | --- |
| PD (min) |  |
| PD (max) |  |
| Work |  |
| Labor costs |  |

## Description

**As** an API client e.g. the mobile app but also the OpenProject UI  
**I want to** see and modify the connection between sprints and work packages via the API  
**so that** I can include sprints in my client

**Acceptance criteria**

*   The end point `GET api/v3/sprints` exists
    
    *   It can be filtered by project - All sprints active on the project are returned including the shared ones
        
*   The end point `GET api/v3/sprints/:id` exists
    
*   The work package resource has a `sprint` property
    
*   All changes are documented in the API docs
    

**Technical notes**

*   <br>
    

**Permissions and visibility considerations**

*   Enforces the same limiations as in the UI, i.e. who is allowed to manage sprints.
    

**Translation considerations**

*   _Key terms and phrases in the key languages_&nbsp;
    

**Out of scope**

*   <br>
    

_Set the_ **To be informed/consulted teams** _field to include all teams necessary to be informed of the changes._