# Kanbanize

Kanbanize is designed to help advanced product teams apply the principles of Lean and Kanban to their work to maximize results.

- **Category:** project management
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 24
- **Triggers:** 0
- **Slug:** `KANBANIZE`
- **Version:** 00000000_00

## Tools

### Add a comment to a card

**Slug:** `KANBANIZE_ADD_CARD_COMMENT`

Tool to add a comment to a Kanbanize card. Use when you need to add notes, updates, or any text-based information to an existing card.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `text` | string | Yes | The comment text content to add to the card. |
| `card_id` | integer | Yes | The ID of the card to add a comment to. |

#### 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 |

### Check Board Milestone

**Slug:** `KANBANIZE_CHECK_BOARD_MILESTONE`

Tool to check if a milestone is available on the specified board. Use when you need to verify milestone existence on a specific board. Returns True if the milestone is available (HTTP 204), False if not found (HTTP 404).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `board_id` | integer | Yes | A board ID to check the milestone on. |
| `milestone_id` | integer | Yes | A milestone ID to check if it is available on the specified board. |

#### 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 |

### Check User Is Card Watcher

**Slug:** `KANBANIZE_CHECK_USER_IS_CARD_WATCHER`

Tool to check if a user is a watcher of a specific card. Use when you need to verify if a user is watching a card.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `card_id` | integer | Yes | A card ID. |
| `user_id` | integer | Yes | A 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 |

### Delete Board

**Slug:** `KANBANIZE_DELETE_BOARD`

Tool to delete a board by its ID. Use when you need to permanently remove a board from Kanbanize. Note: The board must be archived before deletion.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `board_id` | integer | Yes | The ID of the board to delete. Note: The board must be archived before it can be deleted. |

#### 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 Card

**Slug:** `KANBANIZE_DELETE_CARD`

Tool to delete a card from the Kanbanize board. Use when you need to permanently remove a card and all its associated data from the board.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `card_id` | integer | Yes | The ID of the card to delete from the Kanbanize board. |
| `exceeding_reason` | string | No | Optional reason to exceed a limit when deleting the card. Provide this when card deletion may exceed workflow limits or constraints. |

#### 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 Tag

**Slug:** `KANBANIZE_DELETE_TAG`

Tool to delete a tag from Kanbanize. Use when removing a tag and optionally replacing it with another tag for all affected cards.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tag_id` | integer | Yes | A tag ID. |
| `replace_with_tag_id` | integer | No | The ID of the tag that will replace the deleted tag for **all** affected cards. |

#### 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 Workflow

**Slug:** `KANBANIZE_DELETE_WORKFLOW`

Tool to delete a workflow for the specified board. Use when you need to permanently remove a workflow from a board.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `board_id` | integer | Yes | A board ID. |
| `workflow_id` | integer | Yes | A workflow 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 |

### Get Board Block Reasons

**Slug:** `KANBANIZE_GET_BOARD_BLOCK_REASONS`

Tool to get a list of block reasons available on a board. Use when you need to retrieve available block reasons for a specific board.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `board_id` | integer | Yes | A board 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 |

### Get Board Card Templates

**Slug:** `KANBANIZE_GET_BOARD_CARD_TEMPLATES`

Tool to retrieve a list of card templates available on a Kanbanize board. Use when you need to see what card templates are configured for a specific board.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `board_id` | integer | Yes | The unique identifier of the board to retrieve card templates from. |

#### 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 Child Cards

**Slug:** `KANBANIZE_GET_CHILD_CARDS`

Tool to retrieve a list of child cards for a specified parent card. Use when you need to view all cards that are children of a given parent card in the Kanbanize hierarchy.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination. If not specified, defaults to page 1 |
| `card_id` | integer | Yes | The unique identifier of the parent card whose children you want to retrieve |
| `per_page` | integer | No | Number of results per page. Default is 100, maximum is 200 |

#### 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 Column

**Slug:** `KANBANIZE_GET_COLUMN`

Tool to get the details of a specific column from a Kanbanize board. Use when you need to retrieve column information such as name, WIP limit, card ordering, or workflow configuration.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `board_id` | integer | Yes | The ID of the board that contains the column. |
| `column_id` | integer | Yes | The ID of the column to retrieve. |

#### 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 Columns

**Slug:** `KANBANIZE_GET_COLUMNS`

Tool to get a list of columns for a specific board in Kanbanize. Use when you need to retrieve all columns configured for a board, including their workflow assignments, positions, limits, and display settings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `board_id` | integer | Yes | The unique identifier of the board to retrieve columns from. |

#### 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 Custom Fields

**Slug:** `KANBANIZE_GET_CUSTOM_FIELDS`

Tool to retrieve a list of custom fields from Kanbanize with optional filtering. Use when you need to fetch custom field definitions, filter by field IDs, name, availability level, enabled status, types, or retrieve additional details like boards, card counts, and business rules.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Filters custom fields by their exact name. |
| `types` | array | No | A list of the types of custom fields you want to retrieve. |
| `expand` | array | No | A list of properties for which additional details should be included in the response. Options: allowed_values, boards, board_count, card_count, outcome_count, default_contributors, business_rules. |
| `field_ids` | array | No | A list of custom field IDs used to filter the returned custom fields. Example: [1, 2, 3] |
| `is_enabled` | string ("0" | "1") | No | Enum for enabled status. |
| `availability` | array | No | A list of the availability levels by which to filter the custom fields. 0 = On-demand (can be manually added/removed from boards), 1 = Auto (automatically added to all newly created boards), 2 = Global (automatically added to all boards across all workspaces). |
| `is_immutable` | string ("0" | "1") | No | Enum for immutable status. |
| `is_always_present` | string ("0" | "1") | No | Enum for always present status. |

#### 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 Stickers

**Slug:** `KANBANIZE_GET_STICKERS`

Tool to retrieve a list of stickers with optional filtering by sticker IDs, label, availability, and enabled status. Use when you need to fetch stickers from Kanbanize to apply to cards or to view available stickers in the system.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `label` | string | No | The full label of the sticker to search for. If provided, only stickers matching this label will be returned. |
| `is_enabled` | integer | No | Filter stickers by enabled status. Use 0 for disabled stickers, 1 for enabled stickers. If not provided, all stickers are returned. |
| `sticker_ids` | array | No | An array of sticker IDs to filter the results. If provided, only stickers with these IDs will be returned. |
| `availability` | array | No | An array of availability values to filter stickers. Common values are board-specific availability levels. |

#### 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 User

**Slug:** `KANBANIZE_GET_USER`

Tool to get the details of a specified user in Kanbanize. Use when you need to retrieve information about a user such as their username, email, real name, avatar, enabled status, language preferences, timezone, and other attributes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user_id` | integer | Yes | The unique identifier of the user to retrieve. |

#### 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 workflow cycle time columns

**Slug:** `KANBANIZE_GET_WORKFLOW_CYCLE_TIME_COLUMNS`

Tool to retrieve workflow's cycle time columns from a Kanbanize board. Use when you need to identify which columns are included in cycle time calculations for a specific workflow.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `board_id` | integer | Yes | A board ID. |
| `workflow_id` | integer | Yes | A workflow 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 |

### Get Workspace Data Fields

**Slug:** `KANBANIZE_GET_WORKSPACE_DATA_FIELDS`

Tool to retrieve a list of data fields available on a workspace. Use when you need to fetch all custom data fields configured for a specific Kanbanize workspace.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `workspace_id` | integer | Yes | A workspace 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 |

### Remove Board Block Reason

**Slug:** `KANBANIZE_REMOVE_BOARD_BLOCK_REASON`

Tool to make a block reason unavailable on a board. Use when you need to remove a specific block reason from a board's available options.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `board_id` | integer | Yes | A board ID. |
| `reason_id` | integer | Yes | A block reason 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 |

### Remove Child Card

**Slug:** `KANBANIZE_REMOVE_CHILD_CARD`

Tool to remove the link between a parent card and a child card. Use when you need to unlink a child card from its parent card in Kanbanize.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `card_id` | integer | Yes | A card ID. |
| `child_card_id` | integer | Yes | A child card ID. |
| `exceeding_reason` | string | No | The reason for exceeding the specified limit. |

#### 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 |

### Set card block reason

**Slug:** `KANBANIZE_SET_CARD_BLOCK_REASON`

Tool to block a Kanbanize card by setting a block reason. Use when you need to mark a card as blocked and specify the reason preventing progress.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `card_id` | integer | Yes | The ID of the card to block |
| `reason_id` | integer | Yes | The ID of the block reason to apply to the card |

#### 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 Board Sticker

**Slug:** `KANBANIZE_UPDATE_BOARD_STICKER`

Tool to update the properties of a sticker for the specified board. Use when you need to modify usage limits for a sticker on a board or card.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `board_id` | integer | Yes | A board ID. |
| `sticker_id` | integer | Yes | A sticker ID. |
| `limit_per_card` | integer | No | The maximum number of times the sticker can be used on a single card. Use 0 for unlimited. |
| `limit_per_board` | integer | No | The maximum number of times the sticker can be used on the board. Use 0 for unlimited. |

#### 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 Data Field Workspaces

**Slug:** `KANBANIZE_UPDATE_DATA_FIELD_WORKSPACES`

Tool to add, update, or remove a data field on one or more workspaces via batch operations. Use when you need to configure data field availability and settings across multiple workspaces.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data_field_id` | integer | Yes | The data field ID to perform operations on. |
| `workspace_ids_to_remove` | array | No | List of workspace IDs where the data field should be made unavailable. |
| `workspaces_to_add_or_update` | array | No | List of workspaces where the data field should be added or updated. Each entry must include workspace_id. |
| `workspace_ids_for_apply_to_all_boards_to_add` | array | No | List of workspace IDs where the 'apply to all boards in workspace' setting should be enabled. |
| `workspace_ids_for_apply_to_all_boards_to_remove` | array | No | List of workspace IDs where the 'apply to all boards in workspace' setting should be disabled. |
| `workspace_ids_for_value_is_locked_for_all_boards_to_add` | array | No | List of workspace IDs where the 'value is locked for all boards in workspace' setting should be enabled. |
| `workspace_ids_for_value_is_locked_for_all_boards_to_remove` | array | No | List of workspace IDs where the 'value is locked for all boards in workspace' setting should be disabled. |

#### 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 Lane Default Setting

**Slug:** `KANBANIZE_UPDATE_LANE_DEFAULT_SETTING`

Tool to update the default value of a specific lane setting in Kanbanize. Use when you need to modify default settings for a lane on a board.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `value` | integer | Yes | The new value of the setting. |
| `lane_id` | integer | Yes | A lane ID. |
| `board_id` | integer | Yes | A board ID. |
| `setting_name` | string | Yes | A setting name (e.g., 'lane_settings.default_template'). |

#### 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 Tag

**Slug:** `KANBANIZE_UPDATE_TAG`

Tool to update the specified tag in Kanbanize. Use when you need to modify tag properties like label, color, availability, or enabled status.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `color` | string | No | The color of the tag in hexadecimal format. |
| `label` | string | No | The unique label (i.e. the name) assigned to the tag. |
| `tag_id` | integer | Yes | A tag ID. |
| `is_enabled` | integer ("0" | "1") | No | Tag enabled status. |
| `availability` | integer ("0" | "1" | "2") | No | Tag availability levels. |

#### 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 |