Tasks
Bnder API documentation for 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/consumer/v1/guilds/guildId /projects/projectId /tasks
| Parameters | Description |
|---|---|
| guildId | The id of a discord guild |
| projectId | The ID of the project |
| limit | The number of items to return |
| order | The order of the items |
| after_task_id | The task id to start from |
| label_id | The label id to filter |
Request body
empty
Response
Status: 200 - Tasks retrieved
| Field | Type | Description |
|---|---|---|
| task_ids | undefined | The tasks to update |
| check_tasks_exists | boolean | Check if every task exists and remove it if not |
| tasks | array | Task Objects found in the project |
Update task order in kanban board
Updates the task order or changes the tasks state in the kanban board
PUT/consumer/v1/guilds/guildId /projects/projectId /tasks
| Parameters | Description |
|---|---|
| guildId | The id of a discord guild |
| projectId | The ID of the project |
Request body
| Field | Type | Description |
|---|---|---|
| task_ids | undefined | The tasks to update |
| check_tasks_exists | boolean | Check if every task exists and remove it if not |
Response
Status: 200 - Tasks updated
| Field | Type | Description |
|---|---|---|
| task_ids | undefined | The tasks to update |
| check_tasks_exists | boolean | Check if every task exists and remove it if not |
Create a task
Create a task in the project specified by the project id
POST/consumer/v1/guilds/guildId /projects/projectId /tasks
| Parameters | Description |
|---|---|
| guildId | The id of a discord guild |
| projectId | The ID of the project |
Request body
| Field | Type | Description |
|---|---|---|
| text | string | The text of the task |
| description | 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 |
| status | number | The status of the task |
| deadline | string | The deadline of the task |
| effort | number | The effort of the task in percent |
| label_ids | array | The IDs of the labels assigned to the task |
| priority | number | The priority of the task. 0: Low, 1: Normal, 2: High, 3: Urgent |
| repeat_end_date | string | The date when the task repetition ends |
| repeat_days_interval | number | The number of days between task repetitions |
| repeat_at_day_of_month | number | The day of the month when the task repeats |
| subtasks | array | The subtasks of the task |
| watchers_user_ids | array | The IDs of the file attachments of the task |
| milestone_id | string | The ID of the milestone the task belongs to |
| dependencies | array | The IDs of the tasks this task depends on |
Response
Status: 201 - Task created
| 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 | 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 | string | The deadline of the task |
| effort | number | The effort of the task in hours |
| priority | number | The priority of the task. 0: Low, 1: Normal, 2: High, 3: Urgent |
| repeat_days_interval | number | The number of days between task repetitions |
| repeat_end_date | 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 | 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 |
| watchers_user_ids | array | The IDs of the users watching the task |
| milestone_id | string | The ID of the milestone the task belongs to |
| dependencies | array | The IDs of the tasks the task depends on |
| attachments | array | The attachments of the task |
Get a single task
Get all data of a single task by the task id
GET/consumer/v1/guilds/guildId /projects/projectId /tasks/taskId
| Parameters | Description |
|---|---|
| guildId | The id of a discord guild |
| projectId | The ID of the project |
| taskId | The ID of the task |
Request body
empty
Response
Status: 200 - Task retrieved
| 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 | 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 | string | The deadline of the task |
| effort | number | The effort of the task in hours |
| priority | number | The priority of the task. 0: Low, 1: Normal, 2: High, 3: Urgent |
| repeat_days_interval | number | The number of days between task repetitions |
| repeat_end_date | 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 | 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 |
| watchers_user_ids | array | The IDs of the users watching the task |
| milestone_id | string | The ID of the milestone the task belongs to |
| dependencies | array | The IDs of the tasks the task depends on |
| attachments | array | The attachments of the task |
Update a task
Update the data of a task with the given id
PUT/consumer/v1/guilds/guildId /projects/projectId /tasks/taskId
| Parameters | Description |
|---|---|
| guildId | The id of a discord guild |
| projectId | The ID of the project |
| taskId | The ID of the task |
Request body
| Field | Type | Description |
|---|---|---|
| status | number | The status of the task |
| text | string | The text of the task |
| description | 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 | string | The deadline of the task |
| effort | number | The effort of the task in hours |
| priority | number | The priority of the task. 0: Low, 1: Normal, 2: High, 3: Urgent |
| repeat_days_interval | number | The number of days between task repetitions |
| repeat_at_day_of_month | number | The day of the month when the task repeats |
| repeat_end_date | string | The date when the task repetition ends |
| label_ids | array | The IDs of the labels assigned to the task |
| in_bin | boolean | Whether the task is in the bin |
| subtasks | array | The subtasks of the task |
| watchers_user_ids | array | The IDs of the file attachments of the task |
| milestone_id | string | The ID of the milestone the task belongs to |
| dependencies | array | The IDs of the tasks this task depends on |
Response
Status: 200 - Task updated
| 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 | 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 | string | The deadline of the task |
| effort | number | The effort of the task in hours |
| priority | number | The priority of the task. 0: Low, 1: Normal, 2: High, 3: Urgent |
| repeat_days_interval | number | The number of days between task repetitions |
| repeat_end_date | 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 | 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 |
| watchers_user_ids | array | The IDs of the users watching the task |
| milestone_id | string | The ID of the milestone the task belongs to |
| dependencies | array | The IDs of the tasks the task depends on |
| attachments | array | The attachments of the task |
Delete a task
Delete the data of a task with the given id
DELETE/consumer/v1/guilds/guildId /projects/projectId /tasks/taskId
| Parameters | Description |
|---|---|
| guildId | The id of a discord guild |
| projectId | The ID of the project |
| taskId | The ID of the task |
Request body
empty
Response
Status: 204 - Task deleted
empty response
Sort tasks
Sort tasks in the project specified by the project id
POST/consumer/v1/guilds/guildId /projects/projectId /tasks/sort
| Parameters | Description |
|---|---|
| guildId | The id of a discord guild |
| projectId | The ID of the project |
Request body
| Field | Type | Description |
|---|---|---|
| column | string | The column to sort |
| sort_property | string | The property to sort by |
Response
Status: 200 - Tasks sorted
| Field | Type | Description |
|---|---|---|
| task_ids | undefined | The tasks to update |
| check_tasks_exists | boolean | Check if every task exists and remove it if not |
Create a comment
Create a comment in the task specified by the task id
POST/consumer/v1/guilds/guildId /projects/projectId /tasks/taskId /comments
| Parameters | Description |
|---|---|
| guildId | The id of a discord guild |
| projectId | The ID of the project |
| taskId | The ID of the task |
Request body
| Field | Type | Description |
|---|---|---|
| text | string | The text of the comment |
Response
Status: 201 - Comment created
| 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 | 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 | string | The deadline of the task |
| effort | number | The effort of the task in hours |
| priority | number | The priority of the task. 0: Low, 1: Normal, 2: High, 3: Urgent |
| repeat_days_interval | number | The number of days between task repetitions |
| repeat_end_date | 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 | 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 |
| watchers_user_ids | array | The IDs of the users watching the task |
| milestone_id | string | The ID of the milestone the task belongs to |
| dependencies | array | The IDs of the tasks the task depends on |
| attachments | array | The attachments of the task |
Delete a comment
Delete a comment in the task specified by the task id
DELETE/consumer/v1/guilds/guildId /projects/projectId /tasks/taskId /comments
| Parameters | Description |
|---|---|
| guildId | The id of a discord guild |
| projectId | The ID of the project |
| taskId | The ID of the task |
Request body
| 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 |
Response
Status: 200 - Comment deleted
| 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 | 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 | string | The deadline of the task |
| effort | number | The effort of the task in hours |
| priority | number | The priority of the task. 0: Low, 1: Normal, 2: High, 3: Urgent |
| repeat_days_interval | number | The number of days between task repetitions |
| repeat_end_date | 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 | 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 |
| watchers_user_ids | array | The IDs of the users watching the task |
| milestone_id | string | The ID of the milestone the task belongs to |
| dependencies | array | The IDs of the tasks the task depends on |
| attachments | array | The attachments of the task |
Update a comment
Update a comment in the task specified by the task id
PATCH/consumer/v1/guilds/guildId /projects/projectId /tasks/taskId /comments
| Parameters | Description |
|---|---|
| guildId | The id of a discord guild |
| projectId | The ID of the project |
| taskId | The ID of the task |
Request body
| 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 |
Response
Status: 200 - Comment updated
| 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 | 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 | string | The deadline of the task |
| effort | number | The effort of the task in hours |
| priority | number | The priority of the task. 0: Low, 1: Normal, 2: High, 3: Urgent |
| repeat_days_interval | number | The number of days between task repetitions |
| repeat_end_date | 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 | 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 |
| watchers_user_ids | array | The IDs of the users watching the task |
| milestone_id | string | The ID of the milestone the task belongs to |
| dependencies | array | The IDs of the tasks the task depends on |
| attachments | array | The attachments of the task |