> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Kanbanize

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

![Kanbanize logo](https://mintcdn.com/composio-preview/tIuAovF9-7pXq2wA/images/toolkits/kanbanize.svg?fit=max\&auto=format\&n=tIuAovF9-7pXq2wA\&q=85\&s=1bafe061488cb91f7fa18f737646a3f4)

* **Category:** project management
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 24
* **Triggers:** 0
* **Slug:** `KANBANIZE`
* **Version:** 20261101\_00

## Tools

> [accordion] 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
>
> **text** `string` *required*
>
> The comment text content to add to the card.
>
> **card\_id** `integer` *required*
>
> The ID of the card to add a comment to.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **board\_id** `integer` *required*
>
> A board ID to check the milestone on.
>
> **milestone\_id** `integer` *required*
>
> A milestone ID to check if it is available on the specified board.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Check User Is Card Watcher
>
> **Slug:** `KANBANIZE_CHECK_USER_IS_CARD_WATCHER`
>
> Check whether a specified user watches a Kanbanize card. A 404 response is reported as not watching.
>
> #### Input Parameters
>
> **card\_id** `integer` *required*
>
> A card ID.
>
> **user\_id** `integer` *required*
>
> A user ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **board\_id** `integer` *required*
>
> The ID of the board to delete. Note: The board must be archived before it can be deleted.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **card\_id** `integer` *required*
>
> The ID of the card to delete from the Kanbanize board.
>
> **exceeding\_reason** `string`
>
> Optional reason to exceed a limit when deleting the card. Provide this when card deletion may exceed workflow limits or constraints.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Tag
>
> **Slug:** `KANBANIZE_DELETE_TAG`
>
> Deletes a Kanbanize tag, optionally specifying a replacement tag for affected cards. A 404 response is reported as successful deletion.
>
> #### Input Parameters
>
> **tag\_id** `integer` *required*
>
> A tag ID.
>
> **replace\_with\_tag\_id** `integer`
>
> The ID of the tag that will replace the deleted tag for **all** affected cards.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Workflow
>
> **Slug:** `KANBANIZE_DELETE_WORKFLOW`
>
> Delete a specified workflow from a Kanbanize board. The operation identifies the workflow and its board by ID.
>
> #### Input Parameters
>
> **board\_id** `integer` *required*
>
> A board ID.
>
> **workflow\_id** `integer` *required*
>
> A workflow ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **board\_id** `integer` *required*
>
> A board ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **board\_id** `integer` *required*
>
> The unique identifier of the board to retrieve card templates from.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Child Cards
>
> **Slug:** `KANBANIZE_GET_CHILD_CARDS`
>
> Retrieve a page of child cards for a specified parent card in the Kanbanize hierarchy. Pagination parameters and metadata allow additional pages to be requested.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number for pagination. If not specified, defaults to page 1
>
> **card\_id** `integer` *required*
>
> The unique identifier of the parent card whose children you want to retrieve
>
> **per\_page** `integer`
>
> Number of results per page. Default is 100, maximum is 200
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **board\_id** `integer` *required*
>
> The ID of the board that contains the column.
>
> **column\_id** `integer` *required*
>
> The ID of the column to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **board\_id** `integer` *required*
>
> The unique identifier of the board to retrieve columns from.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Custom Fields
>
> **Slug:** `KANBANIZE_GET_CUSTOM_FIELDS`
>
> Retrieve custom field definitions with optional filters and expanded details such as boards, card counts, and business rules. An HTTP 404 is returned as an empty list.
>
> #### Input Parameters
>
> **name** `string`
>
> Filters custom fields by their exact name.
>
> **types** `array`
>
> A list of the types of custom fields you want to retrieve.
>
> **expand** `array`
>
> 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`
>
> A list of custom field IDs used to filter the returned custom fields. Example: \[1, 2, 3]
>
> **is\_enabled** `string ("0" | "1")`
>
> Enum for enabled status.
>
> **availability** `array`
>
> 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")`
>
> Enum for immutable status.
>
> **is\_always\_present** `string ("0" | "1")`
>
> Enum for always present status.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Stickers
>
> **Slug:** `KANBANIZE_GET_STICKERS`
>
> Retrieve Kanbanize stickers, optionally filtering by sticker IDs, label, availability, and enabled status. A 404 response is returned as an empty list.
>
> #### Input Parameters
>
> **label** `string`
>
> The full label of the sticker to search for. If provided, only stickers matching this label will be returned.
>
> **is\_enabled** `integer`
>
> Filter stickers by enabled status. Use 0 for disabled stickers, 1 for enabled stickers. If not provided, all stickers are returned.
>
> **sticker\_ids** `array`
>
> An array of sticker IDs to filter the results. If provided, only stickers with these IDs will be returned.
>
> **availability** `array`
>
> An array of availability values to filter stickers. Common values are board-specific availability levels.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get User
>
> **Slug:** `KANBANIZE_GET_USER`
>
> Retrieves details of a specified Kanbanize user, including profile and account attributes. A 404 response returns empty data.
>
> #### Input Parameters
>
> **user\_id** `integer` *required*
>
> The unique identifier of the user to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **board\_id** `integer` *required*
>
> A board ID.
>
> **workflow\_id** `integer` *required*
>
> A workflow ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Workspace Data Fields
>
> **Slug:** `KANBANIZE_GET_WORKSPACE_DATA_FIELDS`
>
> Retrieves data fields available on a specified Kanbanize workspace. A 404 response is returned as an empty list.
>
> #### Input Parameters
>
> **workspace\_id** `integer` *required*
>
> A workspace ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **board\_id** `integer` *required*
>
> A board ID.
>
> **reason\_id** `integer` *required*
>
> A block reason ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **card\_id** `integer` *required*
>
> A card ID.
>
> **child\_card\_id** `integer` *required*
>
> A child card ID.
>
> **exceeding\_reason** `string`
>
> The reason for exceeding the specified limit.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **card\_id** `integer` *required*
>
> The ID of the card to block
>
> **reason\_id** `integer` *required*
>
> The ID of the block reason to apply to the card
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **board\_id** `integer` *required*
>
> A board ID.
>
> **sticker\_id** `integer` *required*
>
> A sticker ID.
>
> **limit\_per\_card** `integer`
>
> The maximum number of times the sticker can be used on a single card. Use 0 for unlimited.
>
> **limit\_per\_board** `integer`
>
> The maximum number of times the sticker can be used on the board. Use 0 for unlimited.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **data\_field\_id** `integer` *required*
>
> The data field ID to perform operations on.
>
> **workspace\_ids\_to\_remove** `array`
>
> List of workspace IDs where the data field should be made unavailable.
>
> **workspaces\_to\_add\_or\_update** `array`
>
> 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`
>
> 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`
>
> 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`
>
> 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`
>
> List of workspace IDs where the 'value is locked for all boards in workspace' setting should be disabled.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **value** `integer` *required*
>
> The new value of the setting.
>
> **lane\_id** `integer` *required*
>
> A lane ID.
>
> **board\_id** `integer` *required*
>
> A board ID.
>
> **setting\_name** `string` *required*
>
> A setting name (e.g., 'lane\_settings.default\_template').
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **color** `string`
>
> The color of the tag in hexadecimal format.
>
> **label** `string`
>
> The unique label (i.e. the name) assigned to the tag.
>
> **tag\_id** `integer` *required*
>
> A tag ID.
>
> **is\_enabled** `integer ("0" | "1")`
>
> Tag enabled status.
>
> **availability** `integer ("0" | "1" | "2")`
>
> Tag availability levels.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
