Task Types are a feature of the GitScrum API that allows teams to organize tasks into different categories. With Task Types, teams can categorize tasks into Issues, Bugs, Change Requests, Campaigns, Leads, or Ideas to better manage and prioritize their workloads. Task Types also enable teams to easily track progress and identify areas that need more attention.
The GitScrum API provides endpoints for managing these task types and other related resources.
| GET |
/project-templates/type |
| POST |
/project-templates/type |
| PUT |
/project-templates/type/:slug |
| DELETE |
/project-templates/type/:slug |
Attributes
id NUMBER
Unique identifier for the task type object.
slug STRING
Unique identifier for the task type object.
title STRING
The title attribute of a Task Type is a string that describes the type.
More Attributes
{
"id": number,
"title": string,
"description": string,
"slug": string,
"code": null,
"color": string,
"position": number,
"default": boolean
}The Create Task Type endpoint on the GitScrum API enables users to add task types to a project by sending a request using the POST method.
Parameters
title STRING REQUIRED
The title parameter should provide a short name for task types such as developing new features, bug fixes and investigations, for example.
description STRING OPTIONAL
The description is a parameter to give a definition of the type of task.
code STRING OPTIONAL
The code is a code for a task type, using up to 5 characters.
More Parameters
POST /project-templates/type
{
"id": 1,
"title": "Marketing",
"description": "marketing task type",
"slug": "mkt-62d46b585bae7",
"code": null,
"color": "#9900ff",
"position": 1,
"default": false
}To modify the specified task type by changing the values of the supplied parameters, send a PUT request with the updated parameter values. Any parameters not provided will remain unchanged.
Parameters
id NUMBER REQUIRED
Unique identifier for the task type object.
title STRING OPTIONAL
The title parameter should provide a short name for task types such as developing new features, bug fixes and investigations, for example.
description STRING OPTIONAL
The description is a parameter to give a definition of the type of task.
code STRING OPTIONAL
The code is a code for a task type, using up to 5 characters.
More Parameters
PUT /project-templates/type/:id
{
"id": 1,
"title": "Marketing",
"description": "marketing task type",
"slug": "mkt-62d46b585bae7",
"code": null,
"color": "#9900ff",
"position": 1,
"default": false
}Make a GET request to return a sorted list of your Task Types, with the Task Types being sorted by the position attribute in ascending order.
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 /project-templates/type
{
"data": [
{ ... },
{ ... },
{ ... }
],
"total": 20,
"count": 20,
"per_page": 15,
"current_page": 1,
"total_pages": 2
}