The tasks resources for GitScrum API allows users to create and manage tasks, and other related items. Resources include the ability to create, update, delete, and list tasks, as well as to assign tasks to multiple users and define task details including title, due dates, labels, comments, and attachments.
The GitScrum API provides endpoints for managing these tasks and other related resources.
| GET |
/tasks |
| POST |
/tasks |
| GET |
/tasks/:uuid |
| PUT |
/tasks/:uuid |
| DELETE |
/tasks/:uuid |
Attributes
uuid STRING
Unique identifier for the task object.
code STRING
The code attribute is an incremental identifier assigned to a task, 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 task. This code can be used to quickly find the task in a list or search, and can help to organize tasks into different categories.
title STRING
The title attribute of a task is a string that describes the task. It typically contains a brief summary of what the task entails or what needs to be done.
description LONG TEXT
The description attribute of the tasks is a long text type data which holds the textual description about the task. It is used to provide further details about the task and help with understanding its purpose.
More Attributes
{
"uuid": string,
"code": string,
"effort": object,
"type": object,
"timer": boolean,
"has_sprints": boolean,
"has_user_stories": boolean,
"workflow": object,
"parent_id": number or null,
"image": string or null,
"labels": array,
"slug": string,
"title": string,
"description": string or null,
"analyse": object,
"user": object,
"users": array,
"features": array,
"completed_user": object or null,
"completed_date": object or null,
"start_date": array,
"due_date": array,
"created_at": object,
"settings": object,
"time_tracker": string
"time_tracker_user": object or null,
"stats": object,
"company": object,
"project": object,
"board": object,
"sprint": object,
"user_story": object,
"rating": number,
"has_recurring": boolean,
"is_favorite": boolean
}The Create Task endpoint on the GitScrum API allows users to create and add tasks to a project using a POST method.
Parameters
title STRING REQUIRED
The title parameter describes the task in up to 255 characters. It should provide a brief summary of what is needed to be done or an overview of the task.
description STRING OPTIONAL
The description parameter is a string type data which holds a long text that provides further details about the task and helps with understanding its purpose.
workflow_id NUMBER OPTIONAL
The workflow_id parameter is an identifier number that refers to the column of a project in which a task should be added. If this parameter is omitted, GitScrum will add the task to the default column of the workflow.
type_id NUMBER OPTIONAL
The type_id parameter is an identifier number that tells GitScrum which Project Type to add the task to. If this parameter is not specified, GitScrum will automatically assign the task to the default of the Project Type.
More Parameters
POST /tasks
{
"data": {
"uuid": "9cf35748-fbb4-4a6c-99d3-1ff740123dc6",
"code": "#PROJ-13",
"effort": {
"title": "Large",
"effort": "1.00"
},
"type": {
"title": "Marketing",
"color": "9900ff"
},
"timer": true,
"has_sprints": true,
"has_user_stories": true,
"workflow": {
"id": 5204,
"slug": "issue-in-progress",
"state": 2,
"title": "In Progress",
"color": "7bd148"
},
"parent_id": null,
"image": null,
"labels": [
{
"id": 85,
"slug": "yellow-542e3e",
"title": "yellow",
"color": "#FF0000",
"can_edit": false
},
{
"id": 89,
"slug": "black-542e3e",
"title": "black",
"color": "#000000",
"can_edit": false
}
],
"slug": "Task Title",
"state": null,
"title": "task-title",
"description": "Task Description",
"analyse": {
"risk": 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": 29,
"timezone_name": "Europe/Lisbon",
"since": "October 2019"
},
"users": [],
"features": [],
"completed_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"
},
"completed_date": {
"date_for_humans": "29 minutes ago",
"timezone": "2023-05-09 15:34:19",
"timestamp": 1683646459
},
"start_date": {
"date_for_humans": "6 days from now",
"timezone": "2023-05-16 9:30:00",
"timestamp": 1684229400
},
"due_date": {
"date_for_humans": "1 week from now",
"timezone": "2023-05-19 13:00:00",
"timestamp": 1684501200
},
"created_at": {
"date_for_humans": "1 week ago",
"timezone": "2023-05-02 0:16:09",
"timestamp": 1682986569
},
"settings": {
"is_blocker": false,
"is_bug": false,
"is_draft": true,
"is_archived": true
},
"time_tracker": "2023-05-09 16:04:14",
"time_tracker_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"
},
"stats": {
"votes": 0,
"fields": 4,
"time_trackers": 0,
"comments": 0,
"checklists": 0,
"attachments": 0,
"subtasks": 0,
"videos": 0,
"checklist_percentage": 0
},
"company": {
"slug": "gitscrum",
"name": "GitScrum",
"logo": "https://gitscrum-storage-avatars.s3.amazonaws.com/37720bcf1e2f3340c54153d4e999c463f27c25c9.png",
"header_logo": "https://gitscrum-static.s3.amazonaws.com/img/gitscrum-black.png",
"header_color": "#882A2A",
"favicon": "https://gitscrum-storage-avatars.s3.amazonaws.com/9575b6c36682f58fd61e981ae843aac6e6e34263.png",
"owner": {
"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"
}
},
"project": {
"slug": "gitscrum-project-demo",
"name": "GitScrum Project Demo",
"logo": "https://gitscrum-storage-avatars.s3.amazonaws.com/37720bcf1e2f3340c54153d4e999c463f27c25c9.png",
"visibility": {
"is_private": false,
"title": "Public"
},
"recurring": {
"enabled": true,
"limit": 999999
},
"owner": {
"name": "Renato Marinho de Carvalho",
"headline": "GitScrum Founder",
"username": "renato.marinho",
"avatar": "https://gitscrum-storage-avatars.s3.amazonaws.com/5467e2bdd31886166112fea09debe9f72aae06dd.png",
"location": "rew tewr twretrwe trewtrwe",
"timezone_id": 29,
"timezone_name": "Europe/Lisbon",
"since": "October 2019"
}
},
"board": {
"label": "Main Board",
"uuid": "main-board"
},
"sprint": {
"slug": null,
"title": null
},
"user_story": {
"slug": null,
"title": null
},
"rating": 0,
"has_recurring": false,
"is_favorite": false
}
}The Retrieve a Task resource for GitScrum API allows users to view the details of an existing task by providing its unique task UUID. This UUID can be obtained from either a task creation request or from the task list, and when provided, GitScrum will return the corresponding task information.
Parameters
No parameters.
Returns
Returns a task object if a valid identifier is supplied.
GET /tasks
{
"data": {
"uuid": "9cf35748-fbb4-4a6c-99d3-1ff740123dc6",
"code": "#PROJ-13",
"effort": {
"title": "Large",
"effort": "1.00"
},
"type": {
"title": "Marketing",
"color": "9900ff"
},
"timer": true,
"has_sprints": true,
"has_user_stories": true,
"workflow": {
"id": 5204,
"slug": "issue-in-progress",
"state": 2,
"title": "In Progress",
"color": "7bd148"
},
"parent_id": null,
"image": null,
"labels": [
{
"id": 85,
"slug": "yellow-542e3e",
"title": "yellow",
"color": "#FF0000",
"can_edit": false
},
{
"id": 89,
"slug": "black-542e3e",
"title": "black",
"color": "#000000",
"can_edit": false
}
],
"slug": "Task Title",
"state": null,
"title": "task-title",
"description": "Task Description",
"analyse": {
"risk": 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": 29,
"timezone_name": "Europe/Lisbon",
"since": "October 2019"
},
"users": [],
"features": [],
"completed_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"
},
"completed_date": {
"date_for_humans": "29 minutes ago",
"timezone": "2023-05-09 15:34:19",
"timestamp": 1683646459
},
"start_date": {
"date_for_humans": "6 days from now",
"timezone": "2023-05-16 9:30:00",
"timestamp": 1684229400
},
"due_date": {
"date_for_humans": "1 week from now",
"timezone": "2023-05-19 13:00:00",
"timestamp": 1684501200
},
"created_at": {
"date_for_humans": "1 week ago",
"timezone": "2023-05-02 0:16:09",
"timestamp": 1682986569
},
"settings": {
"is_blocker": false,
"is_bug": false,
"is_draft": true,
"is_archived": true
},
"time_tracker": "2023-05-09 16:04:14",
"time_tracker_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"
},
"stats": {
"votes": 0,
"fields": 4,
"time_trackers": 0,
"comments": 0,
"checklists": 0,
"attachments": 0,
"subtasks": 0,
"videos": 0,
"checklist_percentage": 0
},
"company": {
"slug": "gitscrum",
"name": "GitScrum",
"logo": "https://gitscrum-storage-avatars.s3.amazonaws.com/37720bcf1e2f3340c54153d4e999c463f27c25c9.png",
"header_logo": "https://gitscrum-static.s3.amazonaws.com/img/gitscrum-black.png",
"header_color": "#882A2A",
"favicon": "https://gitscrum-storage-avatars.s3.amazonaws.com/9575b6c36682f58fd61e981ae843aac6e6e34263.png",
"owner": {
"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"
}
},
"project": {
"slug": "gitscrum-project-demo",
"name": "GitScrum Project Demo",
"logo": "https://gitscrum-storage-avatars.s3.amazonaws.com/37720bcf1e2f3340c54153d4e999c463f27c25c9.png",
"visibility": {
"is_private": false,
"title": "Public"
},
"recurring": {
"enabled": true,
"limit": 999999
},
"owner": {
"name": "Renato Marinho de Carvalho",
"headline": "GitScrum Founder",
"username": "renato.marinho",
"avatar": "https://gitscrum-storage-avatars.s3.amazonaws.com/5467e2bdd31886166112fea09debe9f72aae06dd.png",
"location": "rew tewr twretrwe trewtrwe",
"timezone_id": 29,
"timezone_name": "Europe/Lisbon",
"since": "October 2019"
}
},
"board": {
"label": "Main Board",
"uuid": "main-board"
},
"sprint": {
"slug": null,
"title": null
},
"user_story": {
"slug": null,
"title": null
},
"rating": 0,
"has_recurring": false,
"is_favorite": false
}
}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 OPTIONAL
The title parameter describes the task in up to 255 characters. It should provide a brief summary of what is needed to be done or an overview of the task.
description STRING OPTIONAL
The description parameter is a string type data which holds a long text that provides further details about the task and helps with understanding its purpose.
workflow_id NUMBER OPTIONAL
The workflow_id parameter is an identifier number that refers to the column of a project in which a task should be added. If this parameter is omitted, GitScrum will add the task to the default column of the workflow.
type_id NUMBER OPTIONAL
The type_id parameter is an identifier number that tells GitScrum which Project Type to add the task to. If this parameter is not specified, GitScrum will automatically assign the task to the default of the Project Type.
More Parameters
PUT /tasks/:uuid
{
"data": {
"uuid": "9cf35748-fbb4-4a6c-99d3-1ff740123dc6",
"code": "#PROJ-13",
"effort": {
"title": "Large",
"effort": "1.00"
},
"type": {
"title": "Marketing",
"color": "9900ff"
},
"timer": true,
"has_sprints": true,
"has_user_stories": true,
"workflow": {
"id": 5204,
"slug": "issue-in-progress",
"state": 2,
"title": "In Progress",
"color": "7bd148"
},
"parent_id": null,
"image": null,
"labels": [
{
"id": 85,
"slug": "yellow-542e3e",
"title": "yellow",
"color": "#FF0000",
"can_edit": false
},
{
"id": 89,
"slug": "black-542e3e",
"title": "black",
"color": "#000000",
"can_edit": false
}
],
"slug": "Task Title",
"state": null,
"title": "task-title",
"description": "Task Description",
"analyse": {
"risk": 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": 29,
"timezone_name": "Europe/Lisbon",
"since": "October 2019"
},
"users": [],
"features": [],
"completed_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"
},
"completed_date": {
"date_for_humans": "29 minutes ago",
"timezone": "2023-05-09 15:34:19",
"timestamp": 1683646459
},
"start_date": {
"date_for_humans": "6 days from now",
"timezone": "2023-05-16 9:30:00",
"timestamp": 1684229400
},
"due_date": {
"date_for_humans": "1 week from now",
"timezone": "2023-05-19 13:00:00",
"timestamp": 1684501200
},
"created_at": {
"date_for_humans": "1 week ago",
"timezone": "2023-05-02 0:16:09",
"timestamp": 1682986569
},
"settings": {
"is_blocker": false,
"is_bug": false,
"is_draft": true,
"is_archived": true
},
"time_tracker": "2023-05-09 16:04:14",
"time_tracker_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"
},
"stats": {
"votes": 0,
"fields": 4,
"time_trackers": 0,
"comments": 0,
"checklists": 0,
"attachments": 0,
"subtasks": 0,
"videos": 0,
"checklist_percentage": 0
},
"company": {
"slug": "gitscrum",
"name": "GitScrum",
"logo": "https://gitscrum-storage-avatars.s3.amazonaws.com/37720bcf1e2f3340c54153d4e999c463f27c25c9.png",
"header_logo": "https://gitscrum-static.s3.amazonaws.com/img/gitscrum-black.png",
"header_color": "#882A2A",
"favicon": "https://gitscrum-storage-avatars.s3.amazonaws.com/9575b6c36682f58fd61e981ae843aac6e6e34263.png",
"owner": {
"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"
}
},
"project": {
"slug": "gitscrum-project-demo",
"name": "GitScrum Project Demo",
"logo": "https://gitscrum-storage-avatars.s3.amazonaws.com/37720bcf1e2f3340c54153d4e999c463f27c25c9.png",
"visibility": {
"is_private": false,
"title": "Public"
},
"recurring": {
"enabled": true,
"limit": 999999
},
"owner": {
"name": "Renato Marinho de Carvalho",
"headline": "GitScrum Founder",
"username": "renato.marinho",
"avatar": "https://gitscrum-storage-avatars.s3.amazonaws.com/5467e2bdd31886166112fea09debe9f72aae06dd.png",
"location": "rew tewr twretrwe trewtrwe",
"timezone_id": 29,
"timezone_name": "Europe/Lisbon",
"since": "October 2019"
}
},
"board": {
"label": "Main Board",
"uuid": "main-board"
},
"sprint": {
"slug": null,
"title": null
},
"user_story": {
"slug": null,
"title": null
},
"rating": 0,
"has_recurring": false,
"is_favorite": false
}
}Return a sorted list of your tasks, with the most recently created tasks 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.
description STRING OPTIONAL
The search query parameters.
GET /tasks
{
"data": [
{ ... },
{ ... },
{ ... }
],
"total": 20,
"count": 20,
"per_page": 15,
"current_page": 1,
"total_pages": 2
}