Tasks
Read the API Overview to get started and learn more.
Get all task ids from a project
Get all task ids from a project specified by the project id
GET /guilds/guildId/projects/projectId/tasks
Parameters
guildId The id of a discord guild
projectId The ID of the project
Responses
200 Response (Tasks retrieved):
| Response Field | Type | Description |
|---|---|---|
| todo_tasks | array | List of task ids that are in todo state |
| in_progress_tasks | array | List of task ids that are in progress state |
| done_tasks | array | List of task ids that are done |
Update task order in kanban board
Updates the task order or changes the tasks state in the kanban board
PUT /guilds/guildId/projects/projectId/tasks
Parameters
guildId The id of a discord guild
projectId The ID of the project
Request body
| Request Field | Type | Description |
|---|---|---|
| todo_tasks | array | List of task ids that are in todo state |
| in_progress_tasks | array | List of task ids that are in progress state |
| done_tasks | array | List of task ids that are done |
Responses
200 Response (Tasks updated):
| Response Field | Type | Description |
|---|---|---|
| todo_tasks | array | List of task ids that are in todo state |
| in_progress_tasks | array | List of task ids that are in progress state |
| done_tasks | array | List of task ids that are done |
Create a task
Create a task in the project specified by the project id
POST /guilds/guildId/projects/projectId/tasks
Parameters
guildId The id of a discord guild
projectId The ID of the project
Request body
| Request Field | Type | Description |
|---|---|---|
| text | string | The text of the task |
| description (optional) | string | The description of the task |
| assigned_user_ids (optional) | array | The IDs of the users assigned to the task |
| assigned_role_ids (optional) | array | The IDs of the roles assigned to the task |
| status (optional) | number | The status of the task. 0: To do, 1: In progress, 2: Done |
| deadline (optional) | string | The deadline of the task |
| label_ids (optional) | array | The IDs of the labels assigned to the task |
| priority (optional) | number | The priority of the task. 0: Low, 1: Normal, 2: High, 3: Urgent |
| repeat_end_date (optional) | string | The date when the task repetition ends |
| repeat_days_interval (optional) | number | The number of days between task repetitions |
| subtasks (optional) | array | The subtasks of the task |
Responses
201 Response (Task created):
| Response Field | Type | Description |
|---|---|---|
| id | string | The ID of the task |
| status | number | The status of the task. 0: To do, 1: In progress, 2: Done |
| text | string | The text of the task |
| description (optional) | string | The description of the task |
| assigned_user_ids | array | The IDs of the users assigned to the task |
| assigned_role_ids | array | The IDs of the roles assigned to the task |
| project_id | string | The ID of the project the task belongs to |
| deadline (optional) | string | The deadline of the task |
| priority | number | The priority of the task. 0: Low, 1: Normal, 2: High, 3: Urgent |
| repeat_days_interval (optional) | number | The number of days between task repetitions |
| repeat_end_date (optional) | string | The date when the task repetition ends |
| label_ids | array | The IDs of the labels assigned to the task |
| creation_date | string | The creation date of the task |
| creator_id | string | The ID of the user who created the task |
| in_bin | boolean | Whether the task is in the bin |
| delete_at (optional) | string | The date the task will be deleted |
| history | array | The history of the task |
| subtasks | array | The subtasks of the task |
| comments | array | The comments of the task |
Get a single task
Get all data of a single task by the task id
GET /guilds/guildId/projects/projectId/tasks/taskId
Parameters
guildId The id of a discord guild
projectId The ID of the project
taskId The ID of the task
Responses
200 Response (Task retrieved):
| Response Field | Type | Description |
|---|---|---|
| id | string | The ID of the task |
| status | number | The status of the task. 0: To do, 1: In progress, 2: Done |
| text | string | The text of the task |
| description (optional) | string | The description of the task |
| assigned_user_ids | array | The IDs of the users assigned to the task |
| assigned_role_ids | array | The IDs of the roles assigned to the task |
| project_id | string | The ID of the project the task belongs to |
| deadline (optional) | string | The deadline of the task |
| priority | number | The priority of the task. 0: Low, 1: Normal, 2: High, 3: Urgent |
| repeat_days_interval (optional) | number | The number of days between task repetitions |
| repeat_end_date (optional) | string | The date when the task repetition ends |
| label_ids | array | The IDs of the labels assigned to the task |
| creation_date | string | The creation date of the task |
| creator_id | string | The ID of the user who created the task |
| in_bin | boolean | Whether the task is in the bin |
| delete_at (optional) | string | The date the task will be deleted |
| history | array | The history of the task |
| subtasks | array | The subtasks of the task |
| comments | array | The comments of the task |
Update a task
Update the data of a task with the given id
PUT /guilds/guildId/projects/projectId/tasks/taskId
Parameters
guildId The id of a discord guild
projectId The ID of the project
taskId The ID of the task
Request body
| Request Field | Type | Description |
|---|---|---|
| status (optional) | number | The status of the task. 0: To do, 1: In progress, 2: Done |
| text (optional) | string | The text of the task |
| description (optional) | string | The description of the task |
| assigned_user_ids (optional) | array | The IDs of the users assigned to the task |
| assigned_role_ids (optional) | array | The IDs of the roles assigned to the task |
| project_id (optional) | string | The ID of the project the task belongs to |
| deadline (optional) | string | The deadline of the task |
| priority (optional) | number | The priority of the task. 0: Low, 1: Normal, 2: High, 3: Urgent |
| repeat_days_interval (optional) | number | The number of days between task repetitions |
| repeat_end_date (optional) | string | The date when the task repetition ends |
| label_ids (optional) | array | The IDs of the labels assigned to the task |
| in_bin (optional) | boolean | Whether the task is in the bin |
| subtasks (optional) | array | The subtasks of the task |
Responses
200 Response (Task updated):
| Response Field | Type | Description |
|---|---|---|
| id | string | The ID of the task |
| status | number | The status of the task. 0: To do, 1: In progress, 2: Done |
| text | string | The text of the task |
| description (optional) | string | The description of the task |
| assigned_user_ids | array | The IDs of the users assigned to the task |
| assigned_role_ids | array | The IDs of the roles assigned to the task |
| project_id | string | The ID of the project the task belongs to |
| deadline (optional) | string | The deadline of the task |
| priority | number | The priority of the task. 0: Low, 1: Normal, 2: High, 3: Urgent |
| repeat_days_interval (optional) | number | The number of days between task repetitions |
| repeat_end_date (optional) | string | The date when the task repetition ends |
| label_ids | array | The IDs of the labels assigned to the task |
| creation_date | string | The creation date of the task |
| creator_id | string | The ID of the user who created the task |
| in_bin | boolean | Whether the task is in the bin |
| delete_at (optional) | string | The date the task will be deleted |
| history | array | The history of the task |
| subtasks | array | The subtasks of the task |
| comments | array | The comments of the task |
Delete a task
Delete the data of a task with the given id
DELETE /guilds/guildId/projects/projectId/tasks/taskId
Parameters
guildId The id of a discord guild
projectId The ID of the project
taskId The ID of the task
Responses
204 Response (Task deleted): Empty response.
Create a comment
Create a comment in the task specified by the task id
POST /guilds/guildId/projects/projectId/tasks/taskId/comments
Parameters
guildId The id of a discord guild
projectId The ID of the project
taskId The ID of the task
Request body
| Request Field | Type | Description |
|---|---|---|
| text | string | The text of the comment |
Responses
201 Response (Comment created):
| Response Field | Type | Description |
|---|---|---|
| id | string | The ID of the task |
| status | number | The status of the task. 0: To do, 1: In progress, 2: Done |
| text | string | The text of the task |
| description (optional) | string | The description of the task |
| assigned_user_ids | array | The IDs of the users assigned to the task |
| assigned_role_ids | array | The IDs of the roles assigned to the task |
| project_id | string | The ID of the project the task belongs to |
| deadline (optional) | string | The deadline of the task |
| priority | number | The priority of the task. 0: Low, 1: Normal, 2: High, 3: Urgent |
| repeat_days_interval (optional) | number | The number of days between task repetitions |
| repeat_end_date (optional) | string | The date when the task repetition ends |
| label_ids | array | The IDs of the labels assigned to the task |
| creation_date | string | The creation date of the task |
| creator_id | string | The ID of the user who created the task |
| in_bin | boolean | Whether the task is in the bin |
| delete_at (optional) | string | The date the task will be deleted |
| history | array | The history of the task |
| subtasks | array | The subtasks of the task |
| comments | array | The comments of the task |
Delete a comment
Delete a comment in the task specified by the task id
DELETE /guilds/guildId/projects/projectId/tasks/taskId/comments
Parameters
guildId The id of a discord guild
projectId The ID of the project
taskId The ID of the task
Request body
| Request Field | Type | Description |
|---|---|---|
| text | string | The text of the comment |
| date | string | The creation date of the comment |
| author_id | string | The ID of the author of the comment |
Responses
200 Response (Comment deleted):
| Response Field | Type | Description |
|---|---|---|
| id | string | The ID of the task |
| status | number | The status of the task. 0: To do, 1: In progress, 2: Done |
| text | string | The text of the task |
| description (optional) | string | The description of the task |
| assigned_user_ids | array | The IDs of the users assigned to the task |
| assigned_role_ids | array | The IDs of the roles assigned to the task |
| project_id | string | The ID of the project the task belongs to |
| deadline (optional) | string | The deadline of the task |
| priority | number | The priority of the task. 0: Low, 1: Normal, 2: High, 3: Urgent |
| repeat_days_interval (optional) | number | The number of days between task repetitions |
| repeat_end_date (optional) | string | The date when the task repetition ends |
| label_ids | array | The IDs of the labels assigned to the task |
| creation_date | string | The creation date of the task |
| creator_id | string | The ID of the user who created the task |
| in_bin | boolean | Whether the task is in the bin |
| delete_at (optional) | string | The date the task will be deleted |
| history | array | The history of the task |
| subtasks | array | The subtasks of the task |
| comments | array | The comments of the task |
