Users of the GitScrum API are able to create, delete, assign, and modify Epics. Epics are large projects that can be divided into individual stories. Initiatives are groups of epics that have a shared objective.
The GitScrum API provides endpoints for managing these epics and other related resources.
| GET | /user-story-epics |
| POST | /user-story-epics |
| GET | /user-story-epics/:slug |
| PUT | /user-story-epics/:slug |
| DELETE | /user-story-epics/:slug |
Attributes
uuid STRING
Unique identifier for the Epic object.
title STRING
The title attribute of a Epic is a string that describes the epic.
More Attributes
{
"uuid": string,
"title": string,
"stats": object,
"user": object,
"color": string or null,
"created_at": object
}The GitScrum API offers a POST method through its Epic endpoint, allowing users to create and add epics to a project.
Parameters
title STRING OPTIONAL
The title parameter is used to provide a short description of an agile epic. It is essential in agile project management, since it helps to organize and plan the backlog and roadmap of a project.
More Parameters
POST /user-story-epics
{
"uuid": "c850ec27-325b-4a2f-aeb5-4cb244c0d9b4",
"title": "Checkout flow V2",
"stats": {
"user_stories": null
},
"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"
},
"color": null,
"created_at": {
"date_for_humans": "1 second ago",
"timezone": "2023-05-11 17:51:09",
"timestamp": 1683827469
}
}The GitScrum API's Retrieve a Epic resource enables users to access the details of an existing epic story by supplying its unique UUID. This UUID can be obtained from either a new epic creation request or from the list of available epics.
Parameters
No parameters.
Returns
Returns a task object if a valid identifier is supplied.
GET /user-story-epics:uuid
{
"data": {
"uuid": "c850ec27-325b-4a2f-aeb5-4cb244c0d9b4",
"title": "Checkout flow V2",
"stats": {
"user_stories": null
},
"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"
},
"color": null,
"created_at": {
"date_for_humans": "1 second ago",
"timezone": "2023-05-11 17:51:09",
"timestamp": 1683827469
}
}
}The PUT request is used to modify an existing resource on a server. To modify the specified epic, the URL in the PUT request must contain the ID of the epic to be modified.
Parameters
title STRING OPTIONAL
The title parameter is used to provide a short description of an agile epic. It is essential in agile project management, since it helps to organize and plan the backlog and roadmap of a project.
More Parameters
PUT /user-story-epic/:uuid
{
"data": {
"uuid": "c850ec27-325b-4a2f-aeb5-4cb244c0d9b4",
"title": "Checkout flow V2",
"stats": {
"user_stories": null
},
"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"
},
"color": null,
"created_at": {
"date_for_humans": "1 second ago",
"timezone": "2023-05-11 17:51:09",
"timestamp": 1683827469
}
}
}Return a sorted list of your Epics, with the most recently created Epics 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.
GET /user-story-epics
{
"data": [
{ ... },
{ ... },
{ ... }
],
"total": 20,
"count": 20,
"per_page": 15,
"current_page": 1,
"total_pages": 2
}