​
Get sprint summary
GET
https://example.kaiten.ru/api/latest/sprints/{id}Returns a detailed summary of a sprint, including cards, their relationships, paths, updates, and custom properties. Requires user to have access to relevant space.
| Name | Type | Reference |
|---|---|---|
| idrequired | integer | Sprint ID |
| Name | Value |
|---|---|
| Authorization | Bearer <token> |
| Content-Type | application/json |
| Name | Type | Constraints | Description |
|---|---|---|---|
| exclude_deleted_cards | boolean | Exclude deleted cards from the summary if true |
Responses
| Description | Response type | Example |
|---|---|---|
| Success | Object |
| Name | Type | Description |
|---|---|---|
| created | string | Sprint creation timestamp |
| updated | string | Sprint last update timestamp |
| archived | boolean | Sprint archived flag |
| id | integer | Sprint ID |
| uid | string | Sprint UID |
| board_id | integer | Board ID the sprint belongs to |
| title | string | Sprint title |
| goal | string | Sprint goal |
| active | boolean | Sprint active status |
| committed | integer | Number of committed cards |
| children_committed | integer | Number of committed child cards |
| velocity | number | Sprint velocity |
| velocity_details | object | Velocity by members |
| children_velocity | number | Velocity of child cards |
| children_velocity_details | object | |
| creator_id | integer | |
| updater_id | integer | |
| start_date | string | |
| finish_date | string | |
| actual_finish_date | string | |
| cards | array of objects | List of cards in the sprint |
| cardUpdates | array of objects | Card versions and states over time |
| customProperties | array of objects | List of custom properties used in sprint cards |
| Description | Response type | Example |
|---|---|---|
| Invalid token | String |
A schema has not been defined for this response code.
| Description | Response type | Example |
|---|---|---|
| User does not have access to view this sprint | Response body does not exist |
A schema has not been defined for this response code.
| Description | Response type | Example |
|---|---|---|
| Sprint not found | Response body does not exist |
A schema has not been defined for this response code.
Kaiten
If you have any questions or need help with integration feel free to write us at support@kaiten.io
Path Parameters
1 curl --request GET \
2 --url 'https://example.kaiten.ru/api/latest/sprints/{id}' \
3 --header 'Accept: application/json' \
4 --header 'Content-Type: application/json'
5 Response
ClickTry It!to start a request and see the response here!