---
canonical_url: "https://docs.composio.dev/toolkits/kanban_tool"
markdown_url: "https://docs.composio.dev/toolkits/kanban_tool.md"
product: "platform"
version: null
last_updated: null
---

# Kanban Tool

Kanban Tool is a visual project and task management platform for organizing boards, workflows, tasks, collaboration, and time tracking.

- **Category:** project management
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 11
- **Triggers:** 0
- **Slug:** `KANBAN_TOOL`
- **Version:** 00000000_00

## Tools

### Add comment

**Slug:** `KANBAN_TOOL_ADD_COMMENT`

Add a text comment to a task.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `content` | string | Yes | Comment text. |
| `task_id` | integer | Yes | Task receiving the comment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Change task lifecycle

**Slug:** `KANBAN_TOOL_CHANGE_TASK_LIFECYCLE`

Archive, unarchive, soft-delete, or restore a task. Treat this as destructive because soft-delete hides the task from active workflows, although restore can reverse it.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `action` | string ("archive" | "unarchive" | "delete" | "restore") | Yes | Lifecycle transition to apply: archive, unarchive, delete (reversible soft-delete), or restore a soft-deleted task. |
| `task_id` | integer | Yes | Task whose lifecycle state should change. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create subtask

**Slug:** `KANBAN_TOOL_CREATE_SUBTASK`

Create a subtask under an existing task or create it unattached for later use, with optional assignment and completion state.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Subtask name. |
| `task_id` | integer | No | Parent task ID. Omit to create an unattached subtask, then pass its ID to CREATE_TASK.subtask_ids when creating the parent task. |
| `is_completed` | boolean | No | Whether the subtask starts completed. |
| `assigned_user_id` | integer | No | Optional assignee user ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create task

**Slug:** `KANBAN_TOOL_CREATE_TASK`

Create a task on a board with optional workflow placement, assignment, estimates, due dates, tags, external references, and previously created unattached subtasks.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Task name. |
| `tags` | array | No | Task tags; sent upstream as comma-separated text. |
| `board_id` | integer | Yes | Destination board ID. |
| `due_date` | string | No | Task due date in YYYY-MM-DD format. |
| `position` | integer | No | Position within the selected stage and swimlane. |
| `priority` | integer ("-1" | "0" | "1") | No | Priority: -1 low, 0 normal, or 1 high. |
| `description` | string | No | Task description. |
| `external_id` | string | No | External-system identifier as an integer or string. |
| `subtask_ids` | array | No | IDs of unattached subtasks from CREATE_SUBTASK to attach to the new task. |
| `swimlane_id` | integer | No | Initial swimlane ID from GET_BOARD. |
| `card_type_id` | integer | No | Card type ID from GET_BOARD. |
| `external_link` | string | No | External-system URL. |
| `size_estimate` | number | No | Size estimate. |
| `time_estimate` | number | No | Time estimate in the account's configured units. |
| `postponed_until` | string | No | Date through which the task is postponed, in YYYY-MM-DD format. |
| `assigned_user_id` | integer | No | Collaborator user ID to assign. |
| `workflow_stage_id` | integer | No | Initial task-bearing leaf workflow stage ID from GET_BOARD. Parent/group stage IDs may be normalized to a child stage by Kanban Tool. |
| `recurring_schedule` | string | No | Recurring-task schedule as an ISO 8601 next-run date-time immediately followed by a JSON schedule object. Requires the Recurring tasks power-up. |
| `assert_has_unique_external_id` | boolean | No | Reject creation if external_id is already used. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete subtask

**Slug:** `KANBAN_TOOL_DELETE_SUBTASK`

Soft-delete a subtask and return its tombstone.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `subtask_id` | integer | Yes | Subtask to soft-delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get board

**Slug:** `KANBAN_TOOL_GET_BOARD`

Fetch a board's workflow configuration and collaborators without loading its full active task collection.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `board_id` | integer | Yes | Board ID returned by LIST_BOARDS or a task. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get task

**Slug:** `KANBAN_TOOL_GET_TASK`

Fetch a task with its comments, subtasks, attachments, changelog, dependencies, and time trackers. A deleted task is returned as a tombstone with deleted_at set.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `task_id` | integer | Yes | Task ID returned by SEARCH_TASKS, CREATE_TASK, or another task response. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List boards

**Slug:** `KANBAN_TOOL_LIST_BOARDS`

List boards available to the connected Kanban Tool user, including each board's permissions and account feature/tier context.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search tasks

**Slug:** `KANBAN_TOOL_SEARCH_TASKS`

Search visible tasks with Kanban Tool query syntax and return one page plus a continuation cursor. Supports board filtering and archived tasks.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Results per page. The provider publishes no maximum. |
| `query` | string | No | Full-text or Kanban Tool filter expression. Examples: 'release notes', 'name:Deploy', 'priority:1', 'tags:"external work"', or 'due_date=2026-09-01'. Use an empty string to list visible tasks. |
| `cursor` | string | No | Opaque continuation cursor returned by a prior call; omit for the first page. |
| `board_ids` | array | No | Board IDs to search. Omit to search every accessible board. |
| `include_archived` | boolean | No | Whether to include archived tasks in the search. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update subtask

**Slug:** `KANBAN_TOOL_UPDATE_SUBTASK`

Update a subtask's name, assignee, or completion state.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | New subtask name. |
| `subtask_id` | integer | Yes | Subtask to update. |
| `is_completed` | boolean | No | New completion state. |
| `assigned_user_id` | integer | No | New assignee; explicitly pass null to clear. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update task

**Slug:** `KANBAN_TOOL_UPDATE_TASK`

Update a task's content, placement, assignment, estimates, dates, tags, or external references. Use CHANGE_TASK_LIFECYCLE to archive, delete, or restore it.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | New task name. |
| `tags` | array | No | Replacement tag list; sent as comma-separated text. Pass an empty list to clear tags. |
| `task_id` | integer | Yes | Task to update. |
| `board_id` | integer | No | Move to this board. |
| `due_date` | string | No | New due date in YYYY-MM-DD format; explicitly pass null to clear. |
| `position` | integer | No | New position. |
| `priority` | integer ("-1" | "0" | "1") | No | Priority: -1 low, 0 normal, or 1 high. |
| `description` | string | No | New description. |
| `external_id` | string | No | New external identifier as an integer or string; explicitly pass null to clear. |
| `swimlane_id` | integer | No | Move to this swimlane. |
| `card_type_id` | integer | No | Set this card type. |
| `external_link` | string | No | New external URL; explicitly pass null to clear. |
| `size_estimate` | number | No | New size estimate; explicitly pass null to clear if supported. |
| `time_estimate` | number | No | New estimate; explicitly pass null to clear if supported by the account. |
| `postponed_until` | string | No | New postponed-through date in YYYY-MM-DD format; explicitly pass null to clear. |
| `assigned_user_id` | integer | No | Assign this user; explicitly pass null to clear assignment. |
| `workflow_stage_id` | integer | No | Move to this workflow stage. |
| `recurring_schedule` | string | No | Recurring-task schedule as an ISO 8601 next-run date-time immediately followed by a JSON schedule object; explicitly pass null to clear. Requires the Recurring tasks power-up. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |