The GitScrum API enables users to build and manage projects, Sprints, and more. Users can create, delete, assign, and customize Sprints while assigning tasks and defining Timebox and Sprint Goals.
The GitScrum API provides endpoints for managing these sprints and other related resources.
| GET |
/sprints |
| POST |
/sprints |
| GET |
/sprints/:slug |
| PUT |
/sprints/:slug |
| DELETE |
/sprints/:slug |
Attributes
id NUMBER
Unique identifier for the sprint object.
slug STRING
Unique identifier for the sprint object.
code STRING
The code attribute is an incremental identifier assigned to a Sprint, which can be updated as needed. It is used to uniquely identify tasks within the project. It typically consists of letters and/or numbers and serves as a unique identifier for the sprint. This code can be used to quickly find the sprint in a list or search, and can help to organize sprints into different categories.
title STRING
The title attribute of a Sprint is a string that describes the sprint.
timebox STRING
The timebox is a period of time allocated for sprint planning. It is used to plan for the upcoming sprint and can include topics such as story points, team capacity, risk and impediments.
More Attributes
{
"id": number,
"code": string,
"slug": string,
"title": string,
"timebox": string,
"duration": string,
"company": object,
"project": object,
"stats": object,
"status": object,
"user": object,
"users": array,
"created_at": object
}The Sprint endpoint on the GitScrum API enables users to quickly create and add sprints to their projects by using the POST method. This allows users to easily manage their sprints and assign tasks accordingly. Additionally, the API provides data about the sprints, such as start and end dates, total estimated hours of work, and other detailed information.
Parameters
title STRING
The title attribute of a Sprint is a string that describes the sprint.
timebox STRING
The timebox is a period of time allocated for sprint planning. It is used to plan for the upcoming sprint and can include topics such as story points, team capacity, risk and impediments.
More Parameters
POST /sprints
{
"data": {
"id": 1,
"code": "#ST-1",
"slug": "645d3940d6572",
"title": "GitScrum Sprint",
"timebox": "11-18 May 2023",
"duration": "7 days",
"company": {
"slug": "gitscrum",
"name": "GitScrum"
},
"project": {
"slug": "gitscrum-project-demo",
"name": "GitScrum Project Demo"
},
"stats": {
"worked_hours": 0,
"tasks": 0,
"closed_tasks": 0,
"completed": 0
},
"status": {
"title": "Standby",
"description": "standby a sprint",
"color": "37c3ff"
},
"user": {
"name": "Renato Marinho de Carvalho",
"headline": "GitScrum Founder",
"username": "renato.marinho",
"avatar": "https://gitscrum-storage-avatars.s3.amazonaws.com/5467e2bdd31886166112fea09debe9f72aae06dd.png",
"location": "Lisbon",
"timezone_id": 37,
"timezone_name": "Etc/Greenwich",
"since": "October 2019"
},
"users": [],
"created_at": {
"date_for_humans": "1 minute ago",
"timezone": "2023-05-11 18:51:44",
"timestamp": 1683831104
}
}
}The GitScrum API's Retrieve a Sprint resource allows users to access the details of an existing sprint by supplying its unique Slug. This Slug can be acquired from either a new sprint creation request or from the list of available sprints, after which GitScrum will return the respective information.
Parameters
No parameters.
Returns
Returns a task object if a valid identifier is supplied.
GET /sprints:slug
{
"data": {
"id": 1,
"code": "#ST-1",
"slug": "645d3940d6572",
"title": "GitScrum Sprint",
"timebox": "11-18 May 2023",
"duration": "7 days",
"company": {
"slug": "gitscrum",
"name": "GitScrum"
},
"project": {
"slug": "gitscrum-project-demo",
"name": "GitScrum Project Demo"
},
"stats": {
"worked_hours": 0,
"tasks": 0,
"closed_tasks": 0,
"completed": 0
},
"status": {
"title": "Standby",
"description": "standby a sprint",
"color": "37c3ff"
},
"user": {
"name": "Renato Marinho de Carvalho",
"headline": "GitScrum Founder",
"username": "renato.marinho",
"avatar": "https://gitscrum-storage-avatars.s3.amazonaws.com/5467e2bdd31886166112fea09debe9f72aae06dd.png",
"location": "Lisbon",
"timezone_id": 37,
"timezone_name": "Etc/Greenwich",
"since": "October 2019"
},
"users": [],
"created_at": {
"date_for_humans": "1 minute ago",
"timezone": "2023-05-11 18:51:44",
"timestamp": 1683831104
}
}
}Modify the specified task by changing the values of the supplied parameters. Any parameters not provided will remain untouched. This can be achieved through a PUT request.
Parameters
title STRING
The title attribute of a Sprint is a string that describes the sprint.
timebox STRING
The timebox is a period of time allocated for sprint planning. It is used to plan for the upcoming sprint and can include topics such as story points, team capacity, risk and impediments.
More Parameters
PUT /sprints/:slug
{
"data": {
"id": 1,
"code": "#ST-1",
"slug": "645d3940d6572",
"title": "GitScrum Sprint",
"timebox": "11-18 May 2023",
"duration": "7 days",
"company": {
"slug": "gitscrum",
"name": "GitScrum"
},
"project": {
"slug": "gitscrum-project-demo",
"name": "GitScrum Project Demo"
},
"stats": {
"worked_hours": 0,
"tasks": 0,
"closed_tasks": 0,
"completed": 0
},
"status": {
"title": "Standby",
"description": "standby a sprint",
"color": "37c3ff"
},
"user": {
"name": "Renato Marinho de Carvalho",
"headline": "GitScrum Founder",
"username": "renato.marinho",
"avatar": "https://gitscrum-storage-avatars.s3.amazonaws.com/5467e2bdd31886166112fea09debe9f72aae06dd.png",
"location": "Lisbon",
"timezone_id": 37,
"timezone_name": "Etc/Greenwich",
"since": "October 2019"
},
"users": [],
"created_at": {
"date_for_humans": "1 minute ago",
"timezone": "2023-05-11 18:51:44",
"timestamp": 1683831104
}
}
}Return a sorted list of your Sprints, with the most recently created Sprints appearing first, using a GET request.
Parameters
page NUMBER OPTIONAL
The page parameter can be used in subsequent calls to access additional pages of results after the initial page. It allows for pagination, allowing the user to navigate through multiple pages of search results.
title STRING OPTIONAL
The search query parameters.
status NUMBER OPTIONAL
The search query parameters.
GET /sprints
{
"data": [
{ ... },
{ ... },
{ ... }
],
"total": 20,
"count": 20,
"per_page": 15,
"current_page": 1,
"total_pages": 2
}