The GitScrum API provides users with the ability to create and manage projects, User Stories, and other items. Users can create, delete, assign, and modify User Stories, as well as assign tasks and provide additional information including acceptance criteria and priority.
The GitScrum API provides endpoints for managing these user stories and other related resources.
| GET | /user-stories |
| POST | /user-stories |
| GET | /user-stories/:slug |
| PUT | /user-stories/:slug |
| DELETE | /user-stories/:slug |
Attributes
slug STRING
Unique identifier for the user story object.
code STRING
The code attribute is an incremental identifier assigned to a User Story, 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 user story. This code can be used to quickly find the user story in a list or search, and can help to organize user stories into different categories.
title STRING
The title attribute of a User Story is a string that describes the user story.
More Attributes
{
"id": number,
"code": string,
"slug": string,
"title": string,
"votes": number,
"priority": object,
"epic": object,
"stats": object,
"company": object,
"project": object,
"user": object,
"users": array,
"created_at": object
}The Create User Story endpoint on the GitScrum API allows users to create and add user stories to a project using a POST method.
Parameters
title STRING OPTIONAL
The title parameter should give a concise summary of the user story and provide an overview of what needs to be done.
additional_information NUMBER OPTIONAL
The additional_information attribute is a long text field that can store additional information related to a user story.
acceptance_criteria NUMBER OPTIONAL
The acceptance_criteria attribute is a string of text that describes the conditions which must be met in order for a user story to be considered complete.
More Parameters
POST user-stories
{
"data": {
"id": 1,
"code": "#US-1",
"slug": "as-a-software-developers-641c7a482eccc",
"title": "As a software developer, I want to use GitScrum to manage my project tasks, so that I can keep track of my progress and collaborate with my team more effectively.",
"votes": 5,
"priority": {
"id": 1,
"title": "Must have",
"color": "#ED1B35",
"total": null
},
"epic": null,
"stats": {
"tasks": 0,
"completed": 0,
"story_points": 0,
"worked_hours": 0
},
"company": {
"slug": "gitscrum",
"name": "GitScrum"
},
"project": {
"slug": "gitscrum-project-demo",
"name": "GitScrum Project Demo"
},
"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": 29,
"timezone_name": "Europe/Lisbon",
"since": "October 2019"
},
"users": [],
"created_at": {
"date_for_humans": "1 month ago",
"timezone": "2023-03-23 16:11:52",
"timestamp": 1679587912
}
}
}The GitScrum API's Retrieve a User Story resource allows users to access the details of an existing story by supplying its unique Slug. This Slug can be acquired from either a new story creation request or from the list of available stories, after which GitScrum will return the respective information.
Parameters
No parameters.
Returns
Returns a task object if a valid identifier is supplied.
GET /user-stories
{
"data": {
"id": 1,
"code": "#US-1",
"slug": "as-a-software-developers-641c7a482eccc",
"title": "As a software developer, I want to use GitScrum to manage my project tasks, so that I can keep track of my progress and collaborate with my team more effectively.",
"votes": 5,
"priority": {
"id": 1,
"title": "Must have",
"color": "#ED1B35",
"total": null
},
"epic": null,
"stats": {
"tasks": 0,
"completed": 0,
"story_points": 0,
"worked_hours": 0
},
"company": {
"slug": "gitscrum",
"name": "GitScrum"
},
"project": {
"slug": "gitscrum-project-demo",
"name": "GitScrum Project Demo"
},
"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": 29,
"timezone_name": "Europe/Lisbon",
"since": "October 2019"
},
"users": [],
"created_at": {
"date_for_humans": "1 month ago",
"timezone": "2023-03-23 16:11:52",
"timestamp": 1679587912
}
}
}Modify the specified user story 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 OPTIONAL
The title parameter should provide a brief summary of the user story, describing the requirements and desired outcomes for an experience. It should provide an overview of what needs to be achieved and the scope of the story.
additional_information NUMBER OPTIONAL
The additional_information attribute is a long text field that can store additional information related to a user story.
acceptance_criteria NUMBER OPTIONAL
The acceptance_criteria attribute is a string of text that describes the conditions which must be met in order for a user story to be considered complete.
More Parameters
PUT user-stories/:slug
{
"data": {
"id": 1,
"code": "#US-1",
"slug": "as-a-software-developers-641c7a482eccc",
"title": "As a software developer, I want to use GitScrum to manage my project tasks, so that I can keep track of my progress and collaborate with my team more effectively.",
"votes": 5,
"priority": {
"id": 1,
"title": "Must have",
"color": "#ED1B35",
"total": null
},
"epic": null,
"stats": {
"tasks": 0,
"completed": 0,
"story_points": 0,
"worked_hours": 0
},
"company": {
"slug": "gitscrum",
"name": "GitScrum"
},
"project": {
"slug": "gitscrum-project-demo",
"name": "GitScrum Project Demo"
},
"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": 29,
"timezone_name": "Europe/Lisbon",
"since": "October 2019"
},
"users": [],
"created_at": {
"date_for_humans": "1 month ago",
"timezone": "2023-03-23 16:11:52",
"timestamp": 1679587912
}
}
}Return a sorted list of your User Stories, with the most recently created User Stories 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/span> OPTIONAL
The search query parameters.
user_story_priority_id NUMBER OPTIONAL
The search query parameters.
GET user-stories
{
"data": [
{ ... },
{ ... },
{ ... }
],
"total": 20,
"count": 20,
"per_page": 15,
"current_page": 1,
"total_pages": 2
}