Tasks
Read the API Overview to get started and learn more.
Create Task
Create a new task.
POST
/
guilds
/
guildId
/
tasks
Request body
| Field | Type | Description |
|---|---|---|
| text | string | Title of the task |
| description (optional) | string | Description of the task |
| assigned_user_ids (optional) | string[] | All ids of users assigned to the task |
| assigned_role_ids (optional) | string[] | All ids of roles assigned to the task |
| status (optional) | number | The tasks status. (Defaults to 0) (Min. 0, Max. 2) |
| deadline (optional) | string | Deadline of the task |
| label_ids (optional) | string[] | Ids of the labels assigned to a task |
| priority (optional) | number | Priority of the task. (Defaults to 1) (Min. 0, Max. 3) |
| repeat_interval_days (optional) | number | How many days should be between the task getting repeated (Min. 1, Max. 365) |
| repeat_end_date (optional) | string | When the task should not get repeated anymore |
Response body
Returns TaskEntity
Returns a 200 status
Update task
Change the data of a task.
POST
/
guilds
/
guildId
/
projects
/
projectId
/
tasks
/
taskId
Request body
| Field | Type | Description |
|---|---|---|
| status (optional) | number | Status of the task (Min. 0, Max. 2) |
| text (optional) | string | Title of the task |
| description (optional) | string | Description of the task |
| assigned_user_ids (optional) | string[] | All ids of users assigned to the task |
| assigned_role_ids (optional) | string[] | All ids of roles assigned to the task |
| project_id (optional) | string | Id of a project |
| deadline (optional) | string | Date of the deadline or "" when deadline should be removed |
| priority (optional) | number | Tasks priority (0 = low, 1 = normal, 2 = high, 3 = urgent) |
| repeat_days_interval (optional) | number | Days until the task repeats again (Min. 1, Max. 365) |
| repeat_end_date (optional) | string | Date until the task gets repeated |
| label_ids (optional) | string[] | All ids of labels assigned to the task |
| in_bin (optional) | boolean | Whether the task should be in bin |
Response body
Returns TaskEntity
Returns a 200 status
Delete task
Delete a task.
DELETE
/
guilds
/
guildId
/
projects
/
projectId
/
tasks
/
taskId
Request body
-
Response body
-
Returns a 204 status
Update task order in project
Changes the order how tasks are displayed in the app.
PUT
/
guilds
/
guildId
/
projects
/
projectId
/
tasks
Request body
| Field | Type | Description |
|---|---|---|
| todo_tasks | string[] | Ids of all tasks in the todo status in the order shown in the app |
| in_progress_tasks | string[] | Ids of all tasks in the "in progress" status in the order shown in the app |
| done_tasks | string[] | Ids of all tasks in the done status in the order shown in the app |
Response body
| Field | Type | Description |
|---|---|---|
| todo_tasks | string[] | Ids of all tasks in the todo status in the order shown in the app |
| in_progress_tasks | string[] | Ids of all tasks in the "in progress" status in the order shown in the app |
| done_tasks | string[] | Ids of all tasks in the done status in the order shown in the app |
Returns a 200 status
Get tasks in project
Returns all ids of tasks inside a project.
GET
/
guilds
/
guildId
/
projects
/
projectId
/
tasks
Request body -
Response body
| Field | Type | Description |
|---|---|---|
| todo_tasks | string[] | Ids of all tasks in the todo status in the order shown in the app |
| in_progress_tasks | string[] | Ids of all tasks in the "in progress" status in the order shown in the app |
| done_tasks | string[] | Ids of all tasks in the done status in the order shown in the app |
Returns a 200 status
Get task data
Get data to one specific task.
GET
/
guilds
/
guildId
/
projects
/
projectId
/
tasks
/
taskId
Request body -
Response body Returns TaskEntity
Returns a 200 status
Add a comment
Add a comment to a task.
POST
/
guilds
/
guildId
/
projects
/
projectId
/
tasks
/
taskId
/
comments
Request body
| Field | Type | Description |
|---|---|---|
| text | string | The comment |
Response body
Returns a 200 status
Returns TaskEntity
Delete a comment
Delete a comment from a task.
DELETE
/
guilds
/
guildId
/
projects
/
projectId
/
tasks
/
taskId
/
comments
Request body
| Field | Type | Description |
|---|---|---|
| text | string | The comment |
| author_id | string | The id of the author of the comment |
| date | string | The date the comment was created |
Response body
Returns a 200 status
Returns TaskEntity
Task Entity
| Field | Type | Description |
|---|---|---|
| id | string | The task ID |
| status | number | The status the task is in (0 = todo, 1 = in progress, 2 = done) |
| text | string | The title of a task |
| description (optional) | string | The description of a task |
| assigned_user_ids | string[] | Ids of assigned users |
| assigned_role_ids | string[] | Ids of assigned roles |
| project_id | string | Id of the tasks project |
| deadline (optional) | string | Deadline set for a task |
| priority | number | Priority of the task (0 = low, 1 = normal, 2 = high, 3 = urgent) |
| repeat_days_interval (optional) | number | In what interval (in days) the task should be repeated (1-365) |
| repeat_end_date (optional) | string | Date when the task should not be repeated |
| label_ids | string[] | Ids of labels assigned to the task |
| creation_date | string | The date the task was created at |
| creator_id | string | Id of the user who created the task. ("api" when it was created by an api user) |
| in_bin | boolean | Whether the task is currently in the bin |
| delete_at (optional) | string | The date when the task is deleted |
| history | History[] | The history of the task |
| subtasks | Subtask[] | The subtasks of the task |
| comments | Comment[] | The comments of the task |
History Entity
| Field | Type | Description |
|---|---|---|
| id | number | Id of the action that was performed on the task |
| executor | string | Id of a user that performed an action. "system" or "api" for non-users |
| timestamp | Date | The timestamp when the action was performed |
| data | Additional data |
History Actions
| Id | Description |
|---|---|
| 0 | Task created |
| 1 | Text edited |
| 2 | Status edited |
| 3 | Task moved to bin |
| 4 | Task moved to another project |
| 5 | Assignees added |
| 6 | Task restored from bin |
| 7 | Deadline edited |
| 8 | Repeat interval removed |
| 9 | Repeat interval set |
| 10 | Assignees removed |
| 11 | Label added |
| 12 | Label removed |
| 13 | Priority changed |
| 14 | Subtask added |
| 15 | Subtask removed |
| 16 | Commit mention |
| 17 | Description edited |
Subtask Entity
| Field | Type | Description |
|---|---|---|
| creation_date | Date | The date when the subtask was created |
| text | string | Text of the subtask |
| completed | boolean | Whether the subtask is completed or not |
Comment Entity
| Field | Type | Description |
|---|---|---|
| text | string | The comment |
| author_id | string | The id of the author of the comment |
| created_at | string | The date the comment was created |
