Miro

Overview

Miro is a collaborative online whiteboard that enables teams to brainstorm, design wireframes, plan workflows, and manage projects visually in real time. With the Miro integration in SquadOS, your agents can create and manipulate boards, add shapes, sticky notes, cards, connectors, images, documents, mind maps, and more — all programmatically.

• Official website: https://miro.com/
• Composio documentation: docs.composio.dev/toolkits/miro

Authentication

This tool uses OAuth 2.0 (OAUTH2) to connect.

You will need to authorize access to your Miro account through Composio’s secure connection page. No manual API key is required.

Field	Required	Description
OAuth Authorization	Yes	Access granted via OAuth 2.0 flow on the Composio connection page.

How to connect in SquadOS

1. Go to Tools in the side menu (/admin/tools).
2. Open the Available tab and search for Miro.
3. Click the card to open the details modal and hit Connect.
4. You’re taken to the secure connection page hosted by Composio, where you authorize access to your Miro account via OAuth.
5. Once done, you’re sent back to SquadOS with the account connected and the tool available for your agents. (Connection-flow details in Organization Tools.)

Available actions

Attach Tag To Item

MIRO_ATTACH_TAG_TO_ITEM

Tool to attach an existing tag to a specific item on a Miro board. Use when you need to associate a tag with an item after confirming the board, item, and tag IDs. Note that card and sticky note items can have up to 8 tags.

Input parameters

Name	Type	Required	Description
tag_id	string	Yes	Unique identifier of the tag to attach to the item.
item_id	string	Yes	Unique identifier of the item to attach the tag to. Card and sticky note items can have up to 8 tags.
board_id	string	Yes	Unique identifier of the board containing the item.

Output

Name	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.

Create App Card Item

MIRO_CREATE_APP_CARD_ITEM

Tool to add an app card item to a board. Use when you need to push a rich preview card with custom fields into a Miro board. Returns the created card; the card ID is nested under data.id in the response, not at the top level. Burst writes may trigger HTTP 429; honor the Retry-After header before retrying.

Input parameters

Name	Type	Required	Description
data	object	Yes	Payload data for the app card.
style	object	No	Styling options for an app card item.
parent	object	No	Parent frame reference for nesting an app card item.
board_id	string	Yes	ID of the board to add the app card to.
geometry	object	No	Geometrical dimensions for an app card item.
position	object	No	Board position for an app card item.

Output

Name	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.

Create Board

MIRO_CREATE_BOARD

Tool to create a new board. Use when you need to set up a board with a specific name, description, and policies. Example: “Create a new board named Project Plan”. If workspace board quota is reached, returns HTTP 400; use MIRO_GET_BOARDS to reuse an existing board instead.

Input parameters

Name	Type	Required	Description
name	string	Yes	Name for the board, length between 1 and 60 characters.
policy	object	No	Defines permissions and sharing policies for the board. Accepts specific enum values only; invalid values return HTTP 400 with error code 2.0703. Valid sharingPolicy values include private, view, comment, edit, team_access.
teamId	string	No	Unique identifier (ID) of the team where the board will be created.
projectId	string	No	Unique identifier (ID) of the project (space) to which the board belongs.
description	string	No	Description of the board, length between 0 and 300 characters.

Output

Name	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.

Create Card Item

MIRO_CREATE_CARD_ITEM

Tool to create a card item on a Miro board. Use when you need to add task cards with titles, descriptions, due dates, and assignees.

Input parameters

Name	Type	Required	Description
data	object	No	Core data for a card item.
style	object	No	Styling options for a card item.
parent	object	No	Parent item reference for nesting a card.
board_id	string	Yes	Unique identifier of the board where the card will be created.
geometry	object	No	Geometrical dimensions for a card item.
position	object	No	Board position for a card item.

Output

Name	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.

Create Connector

MIRO_CREATE_CONNECTOR

Tool to create a connector (edge/arrow) that links two existing board items. Use after creating or locating the two endpoint items (shapes/cards/stickies) to establish visual relationships in flowcharts and diagrams. Both start and end items must be specified; connectors cannot be created with loose endpoints.

Input parameters

Name	Type	Required	Description
shape	string	Yes	Shape/style of the connector line. Values: straight, elbowed, curved.
style	object	No	Visual styling properties for the connector line and caption.
endItem	object	Yes	Defines the ending point of the connector. Must specify either snapTo or position.
board_id	string	Yes	Unique identifier of the board where the connector will be created.
captions	array	No	Array of caption objects to display text along the connector.
startItem	object	Yes	Defines the starting point of the connector. Must specify either snapTo or position.

Output

Name	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.

Create Document Item

MIRO_CREATE_DOCUMENT_ITEM

Tool to create a document item on a Miro board by providing a URL to the document. Use when you need to attach a document (PDF, DOC, etc.) to a board from a publicly accessible URL.

Input parameters

Name	Type	Required	Description
data	object	Yes	Contains the document URL and optional title.
parent	object	No	Parent element reference for hierarchical positioning.
board_id	string	Yes	The unique identifier of the board where the document will be created.
geometry	object	No	Geometric properties with fixed aspect ratio for the document item.
position	object	No	Positioning information for the document item on the board.

Output

Name	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.

Create Document Item Using File From Device

MIRO_CREATE_DOCUMENT_ITEM_USING_FILE_FROM_DEVICE

Tool to create a document item on a Miro board using a URL to the document. Use when you need to add a document (PDF, DOC, etc.) to a board from a publicly accessible URL.

Input parameters

Name	Type	Required	Description
data	object	No	Data containing document metadata like title.
parent	object	No	Parent frame information for the item.
board_id	string	Yes	Unique identifier (ID) of the board where you want to create the item.
geometry	object	No	Geometrical information about the item.
position	object	No	Position information for the document item on the board.
resource	object	Yes	Document file to upload. Maximum file size: 6 MB. Supported format: PDF.

Output

Name	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.

Create Embed Item

MIRO_CREATE_EMBED_ITEM

Tool to create an embed item on a Miro board by providing a URL to embed content (YouTube videos, websites, etc.). Use when you need to add embedded content from external sources to a board.

Input parameters

Name	Type	Required	Description
data	object	Yes	Contains information about the embed URL.
parent	object	No	Parent element reference for hierarchical positioning.
board_id	string	Yes	Unique identifier (ID) of the board where you want to create the item.
geometry	object	No	Geometrical information about the embed item.
position	object	No	Positioning information for the embed item on the board.

Output

Name	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.

Create Frame Item

MIRO_CREATE_FRAME_ITEM

Tool to add a frame item to a Miro board. Use frames to group and organize diagram regions (e.g., swimlanes, sections, slides).

Input parameters

Name	Type	Required	Description
data	object	Yes	Contains frame-specific properties like title and format. This field is required.
style	object	No	Styling options for a frame item.
parent	object	No	Parent item reference for nesting a frame.
board_id	string	Yes	Unique identifier of the board where the frame will be added.
geometry	object	No	Geometrical dimensions for a frame item.
position	object	No	Board position for a frame item.

Output

Name	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.

Create Frame (Deprecated)

MIRO_CREATE_FRAME_ITEM2

DEPRECATED: Use MIRO_CREATE_FRAME_ITEM instead. Tool to create a frame on a Miro board. Use when you need to group and organize content into sections or containers.

Input parameters

Name	Type	Required	Description
data	object	Yes	Contains frame item data, such as the title, frame type, or frame format.
style	object	No	Styling options for a frame item.
board_id	string	Yes	Unique identifier (ID) of the board where you want to create a frame.
geometry	object	No	Geometrical dimensions for a frame item.
position	object	No	Board position for a frame item.

Output

Name	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.

Create Group

MIRO_CREATE_GROUP

Tool to create a group on a Miro board by grouping multiple items together. Use when you need to organize related board items (shapes, sticky notes, cards, etc.) into a single logical group.

Input parameters

Name	Type	Required	Description
data	object	Yes	Contains the data with item IDs to be grouped.
board_id	string	Yes	Unique identifier (ID) of the board where the group will be created.

Output

Name	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.

Create Image Item Using Local File

MIRO_CREATE_IMAGE_ITEM_USING_LOCAL_FILE

Tool to create an image item on a Miro board by uploading a local image file. Use when you need to add an image from the user’s device to a board, rather than referencing an external URL.

Input parameters

Name	Type	Required	Description
data	object	No	Core data for an image item.
parent	object	No	Parent item reference for nesting an image.
board_id	string	Yes	Unique identifier (ID) of the board where you want to create the image item.
geometry	object	No	Geometrical dimensions for an image item.
position	object	No	Board position for an image item.
resource	object	Yes	Image file to upload. Supported formats: PNG, JPG, JPEG, GIF, SVG, etc.

Output

Name	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.

Create Items in Bulk

MIRO_CREATE_ITEMS_IN_BULK

Tool to create multiple items on a Miro board in a single request. Use when you need to add 1-20 items (text, sticky notes, shapes, cards, frames, etc.) efficiently. Items are created atomically in one API call.

Input parameters

Name	Type	Required	Description
items	array	Yes	List of items to create. You can create 1 to 20 items per request.
board_id	string	Yes	Unique identifier of the board where items will be created.

Output

Name	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.

Create Mind Map Node (Experimental)

MIRO_CREATE_MINDMAP_NODE_EXPERIMENTAL

Tool to create a mind map node on a Miro board. Use when building mind maps or organizing ideas visually in a hierarchical structure. This is an experimental endpoint.

Input parameters

Name	Type	Required	Description
data	object	Yes	Core mind map node data including the node view with content.
board_id	string	Yes	Unique identifier (ID) of the board where you want to create the mind map node.
geometry	object	No	Geometry for the mind map node.
position	object	No	Position for the mind map node on the board.

Output

Name	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.

Create Shape Item (Deprecated)

MIRO_CREATE_SHAPE_ITEM

DEPRECATED: Use MIRO_CREATE_SHAPE_ITEM2 instead. Tool to create a native Miro shape item (diagram node) on a board. Use when building diagrams, flowcharts, or architecture diagrams with shapes that can then be connected via MIRO_CREATE_CONNECTOR.

Input parameters

Name	Type	Required	Description
data	object	Yes	Core shape data including content text and shape type.
style	object	No	Styling options for a shape item.
parent	object	No	Parent item reference for nesting a shape.
board_id	string	Yes	Unique identifier of the board where the shape will be created.
geometry	object	No	Geometrical dimensions for a shape item.
position	object	No	Board position for a shape item.

Output

Name	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.

Create Shape Item

MIRO_CREATE_SHAPE_ITEM2

Tool to create a shape item on a Miro board. Use when you need to add shapes (basic or flowchart) to a board with specific styling and positioning.

Input parameters

Name	Type	Required	Description
data	object	No	Core data for a shape item.
style	object	No	Styling options for a shape item.
parent	object	No	Parent frame information for the shape item.
board_id	string	Yes	Unique identifier (ID) of the board where you want to create the item.
geometry	object	No	Geometrical information about the shape item.
position	object	No	Position information for the shape item.

Output

Name	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.

Create Sticky Note Item

MIRO_CREATE_STICKY_NOTE_ITEM

Tool to create a sticky note item on a Miro board. Use when you need to add a new sticky note with customizable content, color, shape, and position.

Input parameters

Name	Type	Required	Description
data	object	No	Contains sticky note item data, such as the content or shape of the sticky note.
style	object	No	Contains information about the style of a sticky note item, such as the fill color or text alignment.
parent	object	No	Contains information about the parent frame for the item.
board_id	string	Yes	Unique identifier (ID) of the board where you want to create the item.
geometry	object	No	Contains geometrical information about the item. You can set either the width or height. You cannot set both the width and height at the same time.
position	object	No	Contains information about the item’s position on the board, such as its x coordinate, y coordinate, and the origin of the x and y coordinates.

Output

Name	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.

Create Tag

MIRO_CREATE_TAG

Tool to create a new tag on a Miro board. Use when you need to add a new tag with a specific title and color to categorize board items.

Input parameters

Name	Type	Required	Description
title	string	Yes	Text of the tag. Case-sensitive. Must be unique within the board.
boardId	string	Yes	Unique identifier (ID) of the board where you want to create the tag.
fillColor	string	No	Fill color for the tag. Options: red, light_green, cyan, yellow, magenta, green, blue, gray, violet, dark_green, dark_blue, black. Defaults to red if not specified.

Output

Name	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.

Create Text Item

MIRO_CREATE_TEXT_ITEM

Tool to create a text item on a Miro board. Use when you need to add text content to a board, such as labels, notes, or annotations.

Input parameters

Name	Type	Required	Description
data	object	Yes	Contains text item data, such as the content.
style	object	No	Styling options for a text item.
parent	object	No	Parent item reference for nesting a text item.
board_id	string	Yes	Unique identifier (ID) of the board where you want to create the item.
geometry	object	No	Geometrical dimensions for a text item.
position	object	No	Board position for a text item.

Output

Name	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.

Delete App Card Item

MIRO_DELETE_APP_CARD_ITEM

Tool to delete an app card item from a board. Use when you need to remove an app card item created by your app after it is no longer needed.

Input parameters

Name	Type	Required	Description
item_id	string	Yes	Unique identifier of the app card item to delete.
board_id	string	Yes	Unique identifier of the board containing the app card item.

Output

Name	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.

Delete Card Item

MIRO_DELETE_CARD_ITEM

Tool to delete a card item from a board. Use when you need to remove a card item from a Miro board after it is no longer needed.

Input parameters

Name	Type	Required	Description
item_id	string	Yes	Unique identifier (ID) of the item that you want to delete.
board_id	string	Yes	Unique identifier (ID) of the board from which you want to delete the item.

Output

Name	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.

Delete Connector

MIRO_DELETE_CONNECTOR

Tool to delete a specific connector from a board. Use when you need to remove a connector (edge/arrow) between board items after confirming its board and connector IDs.

Input parameters

Name	Type	Required	Description
board_id	string	Yes	Unique identifier (ID) of the board from which you want to delete the connector.
connector_id	string	Yes	Unique identifier (ID) of the connector that you want to delete.

Output

Name	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.

Delete Document Item

MIRO_DELETE_DOCUMENT_ITEM

Tool to delete a document item from a board. Use when you need to remove a document item (e.g., PDF or image) that is no longer relevant. Example: “Delete the document item with ID ‘item456’ from board ‘board123’.”

Input parameters

Name	Type	Required	Description
item_id	string	Yes	Unique identifier of the document item to delete.
board_id	string	Yes	Unique identifier of the board containing the document item.

Output

Name	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.

Delete Embed Item

MIRO_DELETE_EMBED_ITEM

Tool to delete an embed item from a board. Use when you need to remove an embedded content item (e.g., YouTube video, website) that is no longer needed.

Input parameters

Name	Type	Required	Description
item_id	string	Yes	Unique identifier (ID) of the item that you want to delete.
board_id	string	Yes	Unique identifier (ID) of the board from which you want to delete the item.

Output

Name	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.

Delete Frame Item

MIRO_DELETE_FRAME_ITEM

Tool to delete a frame item from a Miro board. Use when you need to remove a frame that groups or organizes content on the board.

Input parameters

Name	Type	Required	Description
item_id	string	Yes	Unique identifier (ID) of the frame that you want to delete.
board_id	string	Yes	Unique identifier (ID) of the board from which you want to delete the frame.

Output

Name	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.

Delete Group

MIRO_DELETE_GROUP

Tool to delete a group from a board. Use when you need to remove a group and optionally its items.

Input parameters

Name	Type	Required	Description
board_id	string	Yes	Unique identifier (ID) of the board.
group_id	string	Yes	Unique identifier (ID) of the group.
delete_items	boolean	Yes	Indicates whether the items should be removed. Set to true to delete items in the group.

Output

Name	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.

Delete Image Item

MIRO_DELETE_IMAGE_ITEM

Tool to delete an image item from a board. Use when you need to remove an image that is no longer needed.

Input parameters

Name	Type	Required	Description
item_id	string	Yes	Unique identifier (ID) of the item that you want to delete.
board_id	string	Yes	Unique identifier (ID) of the board from which you want to delete the item.

Output

Name	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.

Delete Item

MIRO_DELETE_ITEM

Tool to delete a specific item from a board. Use when you need to remove an item (e.g., shape, sticky note) after confirming its board and item IDs.

Input parameters

Name	Type	Required	Description
item_id	string	Yes	Unique identifier of the item to delete.
board_id	string	Yes	Unique identifier of the board containing the item.

Output

Name	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.

Delete Mind Map Node (Experimental)

MIRO_DELETE_MINDMAP_NODE_EXPERIMENTAL

Tool to delete a mind map node from a board. Use when you need to remove a mind map node after confirming its board and item IDs. This is an experimental endpoint.

Input parameters

Name	Type	Required	Description
item_id	string	Yes	Unique identifier (ID) of the mind map node that you want to delete.
board_id	string	Yes	Unique identifier (ID) of the board from which you want to delete the mind map node.

Output

Name	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.

Delete Shape Item

MIRO_DELETE_SHAPE_ITEM

Tool to delete a shape item from a board. Use when you need to remove a specific shape that is no longer needed after confirming its board and item IDs.

Input parameters

Name	Type	Required	Description
item_id	string	Yes	Unique identifier (ID) of the item that you want to delete.
board_id	string	Yes	Unique identifier (ID) of the board from which you want to delete the item.

Output

Name	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.

Delete Sticky Note Item

MIRO_DELETE_STICKY_NOTE_ITEM

Tool to delete a sticky note item from a board. Use when you need to remove a sticky note that is no longer needed.

Input parameters

Name	Type	Required	Description
item_id	string	Yes	Unique identifier (ID) of the item that you want to delete.
board_id	string	Yes	Unique identifier (ID) of the board from which you want to delete the item.

Output

Name	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.

Delete Tag

MIRO_DELETE_TAG

Tool to delete a specific tag from a board. Use when you need to remove a tag after confirming its board and tag IDs.

Input parameters

Name	Type	Required	Description
tag_id	string	Yes	Unique identifier (ID) of the tag that you want to delete.
board_id	string	Yes	Unique identifier (ID) of the board where you want to delete a specific tag.

Output

Name	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.

Delete Text Item

MIRO_DELETE_TEXT_ITEM

Tool to delete a text item from a board. Use when you need to remove a text item after confirming its board and item IDs.

Input parameters

Name	Type	Required	Description
item_id	string	Yes	Unique identifier (ID) of the item that you want to delete.
board_id	string	Yes	Unique identifier (ID) of the board from which you want to delete the item.

Output

Name	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.

Get All Groups

MIRO_GET_ALL_GROUPS

Tool to retrieve all groups on a Miro board with cursor-based pagination. Use when you need to list all groups and their associated items on a board.

Input parameters

Name	Type	Required	Description
limit	integer	No	The maximum number of groups to return at one time. Default is 10, minimum is 10, maximum is 50.
cursor	string	No	Cursor for pagination. Use the cursor value from a previous response to retrieve the next page of results.
board_id	string	Yes	Unique identifier (ID) of the board.

Output

Name	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.

Get App Card Item 2

MIRO_GET_APP_CARD_ITEM2

Tool to retrieve a specific app card item by its ID from a Miro board. Use when you need to get the details of an existing app card item.

Input parameters

Name	Type	Required	Description
item_id	string	Yes	Unique identifier (ID) of the item that you want to retrieve.
board_id	string	Yes	Unique identifier (ID) of the board from which you want to retrieve a specific item.

Output

Name	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.

Get Board (Deprecated)

MIRO_GET_BOARD

DEPRECATED: Use MIRO_GET_SPECIFIC_BOARD instead. Tool to retrieve details of a specific board. Use when you have a board ID and need to fetch its metadata.

Input parameters

Name	Type	Required	Description
board_id	string	Yes	Unique identifier of the board to retrieve.

Output

Name	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.

Get Board Items

MIRO_GET_BOARD_ITEMS

Tool to list items on a Miro board (shapes, stickies, cards, etc.) with pagination. Use when you need to page through board elements for analytics or reporting. Re-fetch before bulk updates to avoid stale item IDs.

Input parameters

Name	Type	Required	Description
type	string	No	Filter by item type. Values: ai_generation_result, app_card, card, data_table_format, diagram, doc_format, document, embed, frame, image, mindmap_node, shape, sticky_note, text. Note: connector is not supported; use the separate Get Connectors action instead.
limit	integer	No	Maximum number of items to return per page (10-50).
cursor	string	No	Cursor for paginating results; use the value from a prior response. Loop: pass the cursor from each response into the next call; stop when cursor is null (all items retrieved).
board_id	string	Yes	Unique identifier of the board to retrieve items from.

Output

Name	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.

Get Board Members

MIRO_GET_BOARD_MEMBERS

Tool to retrieve a list of members for a board. Use when you need to list all users with access to a board after confirming its ID. Results are scoped to the authenticated user’s permissions; members or boards inaccessible to that user will not appear in the response.

Input parameters

Name	Type	Required	Description
limit	integer	No	Number of results per page (max 100).
cursor	string	No	Cursor for pagination, used to retrieve subsequent pages.
board_id	string	Yes	Unique identifier of the board.

Output

Name	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.

Get Boards (Deprecated)

MIRO_GET_BOARDS

DEPRECATED: Use MIRO_GET_BOARDS2 instead. Tool to retrieve accessible boards with optional filters. Use when you need to list or search boards by team, project, owner, or keywords. Only boards accessible to the authenticated user are returned.

Input parameters

Name	Type	Required	Description
sort	string	No	Sort order of the results. Values: default, last_created, last_opened, last_modified, alphabetically.
limit	integer	No	Number of boards to return per page (1-50). Values above 50 cause a 400 error.
owner	string	No	Filter boards by owner user ID.
query	string	No	Search query to filter boards by name.
offset	integer	No	Offset for pagination. Increment by limit value until results are exhausted to retrieve all pages.
team_id	string	No	Filter boards by team ID.
project_id	string	No	Filter boards by project (space) ID.

Output

Name	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.

Get Boards V2

MIRO_GET_BOARDS2

Tool to retrieve accessible boards with optional filters. Use when you need to list or search boards by team, project, owner, or keywords with full pagination support.

Input parameters

Name	Type	Required	Description
sort	string	No	Sort order in which you want to view the result set. Options last_created and alphabetically are applicable only when you search for boards by team. Values: default, last_modified, last_opened, last_created, alphabetically. Default: default (If team_id is present, last_created. Otherwise, last_opened).
limit	integer	No	Maximum number of boards to retrieve (1-50). Default: 20.
owner	string	No	Retrieves a list of boards that belong to a specific owner ID.
query	string	No	Retrieves a list of boards that contain the query string provided in the board name or board description.
offset	integer	No	Zero-based offset of the first item in the collection. Default: 0.
team_id	string	No	The team_id for which you want to retrieve the list of boards. If this parameter is sent in the request, the query and owner parameters are ignored.
project_id	string	No	The project_id for which you want to retrieve the list of boards. If this parameter is sent in the request, the query and owner parameters are ignored.

Output

Name	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.

Get Card Item

MIRO_GET_CARD_ITEM

Tool to retrieve a specific card item from a Miro board. Use when you need to fetch details of an existing card item by its ID.

Input parameters

Name	Type	Required	Description
item_id	string	Yes	Unique identifier (ID) of the item that you want to retrieve.
board_id	string	Yes	Unique identifier (ID) of the board from which you want to retrieve a specific item.

Output

Name	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.

Get Connector

MIRO_GET_CONNECTOR

Tool to retrieve a specific connector by its ID. Use when you need details about an existing connector on a board.

Input parameters

Name	Type	Required	Description
board_id	string	Yes	Unique identifier (ID) of the board from which you want to retrieve a specific connector.
connector_id	string	Yes	Unique identifier (ID) of the connector that you want to retrieve.

Output

Name	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.

Get Connectors

MIRO_GET_CONNECTORS

Tool to retrieve a list of connectors on a board. Use after confirming the board ID and when you need to page through connector items.

Input parameters

Name	Type	Required	Description
limit	integer	No	Maximum number of results to return per call (10 to 50). Defaults to 10.
cursor	string	No	Cursor for pagination to retrieve the next page of connectors. Pass the cursor returned by the previous response to fetch the next page; when the response returns a null cursor, all pages have been retrieved.
board_id	string	Yes	Unique identifier of the board to retrieve connectors from.

Output

Name	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.

Get Document Item

MIRO_GET_DOCUMENT_ITEM

Tool to retrieve a specific document item from a Miro board by its ID. Use when you need to get details about an existing document item.

Input parameters

Name	Type	Required	Description
item_id	string	Yes	Unique identifier (ID) of the item that you want to retrieve.
board_id	string	Yes	Unique identifier (ID) of the board from which you want to retrieve a specific item.

Output

Name	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.

Get Embed Item

MIRO_GET_EMBED_ITEM

Tool to retrieve a specific embed item from a board by its ID. Use when you need details of an existing embedded content item.

Input parameters

Name	Type	Required	Description
item_id	string	Yes	Unique identifier (ID) of the item that you want to retrieve.
board_id	string	Yes	Unique identifier (ID) of the board from which you want to retrieve a specific item.

Output

Name	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.

Get Frame Item

MIRO_GET_FRAME_ITEM

Tool to retrieve a specific frame item from a Miro board. Use when you need to fetch details of an existing frame by its ID.

Input parameters

Name	Type	Required	Description
item_id	string	Yes	Unique identifier (ID) of the frame that you want to retrieve.
board_id	string	Yes	Unique identifier (ID) of the board that contains the frame that you want to retrieve.

Output

Name	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.

Get Group By ID

MIRO_GET_GROUP_BY_ID

Tool to retrieve a specific group by its ID. Use when you need to get details about a group on a Miro board.

Input parameters

Name	Type	Required	Description
board_id	string	Yes	Unique identifier (ID) of the board.
group_id	string	Yes	Unique identifier (ID) of the group.

Output

Name	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.

Get Image Item

MIRO_GET_IMAGE_ITEM

Tool to retrieve a specific image item from a board. Use when you need to get details about an existing image item.

Input parameters

Name	Type	Required	Description
item_id	string	Yes	Unique identifier (ID) of the item that you want to retrieve.
board_id	string	Yes	Unique identifier (ID) of the board from which you want to retrieve a specific item.

Output

Name	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.

Get Item Tags

MIRO_GET_ITEM_TAGS

Tool to retrieve tags attached to a specific item on a Miro board. Use when you need to get the tags associated with a particular item.

Input parameters

Name	Type	Required	Description
item_id	string	Yes	Unique identifier of the item to retrieve tags from.
board_id	string	Yes	Unique identifier of the board containing the item.

Output

Name	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.

Get Mind Map Node

MIRO_GET_MINDMAP_NODE_EXPERIMENTAL

Tool to retrieve a specific mind map node from a board. Use when you need to get details about a mind map node by its ID.

Input parameters

Name	Type	Required	Description
item_id	string	Yes	Unique identifier (ID) of the mind map node that you want to retrieve.
board_id	string	Yes	Unique identifier (ID) of the board from which you want to retrieve a mind map node.

Output

Name	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.

Get Mind Map Nodes (Experimental)

MIRO_GET_MINDMAP_NODES_EXPERIMENTAL

Tool to retrieve mind map nodes from a Miro board. Use when you need to access the structure and content of mind maps on a board.

Input parameters

Name	Type	Required	Description
limit	string	No	Maximum number of results returned.
cursor	string	No	Points to the next portion of the results set. Use the cursor value from a previous response to retrieve the next page.
board_id	string	Yes	Unique identifier (ID) of the board from which you want to retrieve mind map nodes.

Output

Name	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.

Get oEmbed Data

MIRO_GET_OEMBED

Tool to retrieve oEmbed data for a Miro board. Use when you need to generate embeddable HTML code for a board or get board metadata in oEmbed format.

Input parameters

Name	Type	Required	Description
url	string	Yes	The URL pointing to the Miro board resource to return as oEmbed data. Must be a valid Miro board URL (e.g., https://miro.com/app/board/uXjVJ_fzYUs=).
format	string	No	Specifies the return format of the response. Only json is supported. Defaults to json if not specified.
maxwidth	integer	No	The maximum width available to the embed, in pixels. The oEmbed response will respect this constraint.
referrer	string	No	The URL pointing to the source of the request. Used to track where the embed will be displayed.
maxheight	integer	No	The maximum height available to the embed, in pixels. The oEmbed response will respect this constraint.

Output

Name	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.

Get Shape Item

MIRO_GET_SHAPE_ITEM

Tool to retrieve a specific shape item from a Miro board by its ID. Use when you need to get details of an existing shape item.

Input parameters

Name	Type	Required	Description
item_id	string	Yes	Unique identifier (ID) of the item that you want to retrieve.
board_id	string	Yes	Unique identifier (ID) of the board from which you want to retrieve a specific item.

Output

Name	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.

Get Specific Board

MIRO_GET_SPECIFIC_BOARD

Tool to retrieve detailed information about a specific board by its ID. Use when you need to fetch complete metadata including team, permissions, owner, and modification details for a board.

Input parameters

Name	Type	Required	Description
board_id	string	Yes	Unique identifier (ID) of the board that you want to retrieve.

Output

Name	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.

Get Specific Board Member

MIRO_GET_SPECIFIC_BOARD_MEMBER

Tool to retrieve details of a specific board member. Use when you have a board ID and board member ID and need to get that member’s role and information.

Input parameters

Name	Type	Required	Description
board_id	string	Yes	Unique identifier (ID) of the board to which the board member belongs.
board_member_id	string	Yes	Unique identifier (ID) of the board member whose role you want to retrieve.

Output

Name	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.

Get Specific Item

MIRO_GET_SPECIFIC_ITEM

Tool to retrieve a specific item from a Miro board by its ID. Use when you need details about a particular board item (sticky note, shape, card, frame, etc.).

Input parameters

Name	Type	Required	Description
item_id	string	Yes	Unique identifier (ID) of the item that you want to retrieve.
board_id	string	Yes	Unique identifier (ID) of the board from which you want to retrieve a specific item.

Output

Name	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.

Get Sticky Note Item

MIRO_GET_STICKY_NOTE_ITEM

Tool to retrieve a specific sticky note item from a board by its ID. Use when you need to get the details of an existing sticky note item.

Input parameters

Name	Type	Required	Description
item_id	string	Yes	Unique identifier (ID) of the item that you want to retrieve.
board_id	string	Yes	Unique identifier (ID) of the board from which you want to retrieve a specific item.

Output

Name	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.

Get Tag

MIRO_GET_TAG

Tool to retrieve details of a specific tag on a board. Use when you have a board ID and tag ID and need its metadata.

Input parameters

Name	Type	Required	Description
tag_id	string	Yes	Unique identifier of the tag to retrieve.
board_id	string	Yes	Unique identifier of the board where the tag resides.

Output

Name	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.

Get Text Item

MIRO_GET_TEXT_ITEM

Tool to retrieve a specific text item from a Miro board by its ID. Use when you need to get the details of an existing text item.

Input parameters

Name	Type	Required	Description
item_id	string	Yes	Unique identifier (ID) of the item that you want to retrieve.
board_id	string	Yes	Unique identifier (ID) of the board from which you want to retrieve a specific item.

Output

Name	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.

List Board Tags

MIRO_LIST_BOARD_TAGS

Tool to list all tags on a Miro board. Use when you need to discover tag IDs, titles, or colors before performing tag operations.

Input parameters

Name	Type	Required	Description
limit	integer	No	Maximum number of tags to return per page (min 1).
cursor	string	No	Cursor for paginating results; use the value from a prior response.
board_id	string	Yes	Unique identifier of the board to retrieve tags from.

Output

Name	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.

Get Organization Context

MIRO_LIST_ORGANIZATIONS

Retrieves the organization associated with the current access token. Note: Miro’s API does not have an endpoint to list all organizations a user has access to. This action uses the /v1/oauth-token endpoint to return the single organization context associated with the authenticated token, along with team and user information. For Enterprise users who need to work with organizations, use organization-specific endpoints like MIRO_GET_ORGANIZATION_MEMBERS which require an org_id parameter.

Output

Name	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.

Share Board

MIRO_SHARE_BOARD

Tool to share a board by inviting users via email. Use when you need to grant access to a board by sending email invitations to new members. You can invite up to 20 users per call and assign them roles (viewer, commenter, editor, coowner, or owner).

Input parameters

Name	Type	Required	Description
role	string	No	Role of the board members being invited. Options: viewer (view only), commenter (view and comment), editor (view, comment, and edit), coowner (full access except changing owner), owner (full access including changing owner). Note: Inviting users with role owner has the same effect as coowner.
emails	array	Yes	Email addresses of the users you want to invite to the board. You can invite up to 20 members per call.
message	string	No	Optional message that will be sent in the invitation email to the invited users.
board_id	string	Yes	Unique identifier (ID) of the board to which you want to invite members.

Output

Name	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.

Update App Card Item 2

MIRO_UPDATE_APP_CARD_ITEM2

Tool to update an app card item on a Miro board. Use when you need to modify properties of an existing app card such as title, description, status, style, position, or geometry.

Input parameters

Name	Type	Required	Description
data	object	No	Core data for an app card item.
style	object	No	Styling information for an app card item.
parent	object	No	Parent frame information for an app card item.
item_id	string	Yes	Unique identifier (ID) of the item that you want to update.
board_id	string	Yes	Unique identifier (ID) of the board where you want to update the item.
geometry	object	No	Geometrical information about an app card item.
position	object	No	Position information for an app card item.

Output

Name	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.

Update Board

MIRO_UPDATE_BOARD

Tool to update properties of a specific board. Use when you have a board ID and need to modify its name, description, or permissions policy. Use after confirming the board exists.

Input parameters

Name	Type	Required	Description
name	string	No	New name for the board (1-60 characters).
policy	object	No	Defines permissions and sharing policies for the board. Contains sharingPolicy subfield accepting specific enum values (e.g., private, view, comment, edit); invalid values return 400.
teamId	string	No	ID of the team where the board should be placed.
boardId	string	Yes	Unique identifier (ID) of the board to update.
projectId	string	No	ID of the project (space) to which the board should be added.
description	string	No	New description for the board (up to 300 characters).

Output

Name	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.

Update Board Member

MIRO_UPDATE_BOARD_MEMBER

Tool to update the role of a specific board member. Use when you have a board ID and board member ID and need to change that member’s permissions or role on the board.

Input parameters

Name	Type	Required	Description
role	string	No	Role of the board member. Can be viewer (view only), commenter (view and comment), editor (view, comment, and edit), coowner (full access except changing owner), or owner (full access including changing owner).
board_id	string	Yes	Unique identifier (ID) of the board for which you want to update the role of the board member.
board_member_id	string	Yes	Unique identifier (ID) of the board member whose role you want to update.

Output

Name	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.

Update Card Item

MIRO_UPDATE_CARD_ITEM

Tool to update a card item on a Miro board. Use when you need to modify properties of an existing card item such as title, description, due date, assignee, style, position, or geometry.

Input parameters

Name	Type	Required	Description
data	object	No	Contains card item data to update, such as the title, description, due date, or assignee ID.
style	object	No	Contains information about the style of a card item to update, such as the card theme.
parent	object	No	Contains information about the parent frame for the item.
item_id	string	Yes	Unique identifier (ID) of the item that you want to update.
board_id	string	Yes	Unique identifier (ID) of the board where you want to update the item.
geometry	object	No	Contains geometrical information to update about the item, such as its width or height.
position	object	No	Contains position information to update for the item on the board.

Output

Name	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.

Update Connector

MIRO_UPDATE_CONNECTOR

Tool to update an existing connector on a Miro board. Use when you need to modify connector properties such as shape, style, captions, or endpoint attachments. Only provided fields will be updated.

Input parameters

Name	Type	Required	Description
shape	string	No	The path type of the connector line, defines curvature. Values: straight, elbowed, curved. Default: curved.
style	object	No	Visual styling properties for the connector line and caption.
endItem	object	No	Defines the starting or ending point of a connector.
board_id	string	Yes	Unique identifier (ID) of the board for which you want to update the connector.
captions	array	No	Blocks of text you want to display on the connector. Maximum 20 captions allowed.
startItem	object	No	Defines the starting or ending point of a connector.
connector_id	string	Yes	Unique identifier (ID) of the connector that you want to update.

Output

Name	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.

Update Document Item

MIRO_UPDATE_DOCUMENT_ITEM

Tool to update a document item on a Miro board. Use when you need to modify properties of an existing document item such as URL, title, position, or geometry.

Input parameters

Name	Type	Required	Description
data	object	No	Data for document URL information.
parent	object	No	Parent element reference for hierarchical positioning.
item_id	string	Yes	Unique identifier (ID) of the item that you want to update.
board_id	string	Yes	Unique identifier (ID) of the board where you want to update the item.
geometry	object	No	Geometric properties for the document item. You can set either width or height, not both.
position	object	No	Positioning information for the document item on the board.

Output

Name	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.

Update Embed Item

MIRO_UPDATE_EMBED_ITEM

Tool to update an embed item on a board. Use when you need to modify properties of an existing embedded content item such as position, display mode, or URL.

Input parameters

Name	Type	Required	Description
data	object	No	Data fields for updating the embed item.
parent	object	No	Contains information about the parent frame for the item.
item_id	string	Yes	Unique identifier (ID) of the item that you want to update.
board_id	string	Yes	Unique identifier (ID) of the board where you want to update the item.
geometry	object	No	Contains geometrical information about the item. You can set either width or height, but not both at the same time.
position	object	No	Contains information about the item’s position on the board.

Output

Name	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.

Update Frame Item

MIRO_UPDATE_FRAME_ITEM

Tool to update a frame item on a Miro board. Use when you need to modify properties of an existing frame such as title, position, size, or styling. Include only fields to change.

Input parameters

Name	Type	Required	Description
data	object	No	Core data for updating a frame item.
style	object	No	Styling options for updating a frame item.
item_id	string	Yes	Unique identifier (ID) of the frame that you want to update.
board_id	string	Yes	Unique identifier (ID) of the board where you want to update the frame.
geometry	object	No	Geometrical dimensions for updating a frame item.
position	object	No	Board position for updating a frame item.

Output

Name	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.

Update Group

MIRO_UPDATE_GROUP

Tool to update a group on a Miro board with new items. Use when you need to change which items belong to an existing group.

Input parameters

Name	Type	Required	Description
data	object	Yes	Contains the data with item IDs to be included in the group.
board_id	string	Yes	Unique identifier (ID) of the board.
group_id	string	Yes	Unique identifier (ID) of the group to update.

Output

Name	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.

Update Image Item

MIRO_UPDATE_IMAGE_ITEM

Tool to update an existing image item on a board. Use when you need to modify properties of an existing image item such as title, URL, position, or geometry.

Input parameters

Name	Type	Required	Description
data	object	No	Data fields to update for the image item.
parent	object	No	Contains information about the parent frame for the item.
item_id	string	Yes	Unique identifier (ID) of the item that you want to update.
board_id	string	Yes	Unique identifier (ID) of the board where you want to update the item.
geometry	object	No	Contains geometrical information about the item. You can set either the width or height, you cannot set both at the same time.
position	object	No	Contains information about the item’s position on the board.

Output

Name	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.

Update Item Position or Parent

MIRO_UPDATE_ITEM_POSITION_OR_PARENT

Tool to update an item’s position or parent frame on a Miro board. Use when you need to move an item to a new location or assign it to a different parent frame.

Input parameters

Name	Type	Required	Description
parent	object	No	Parent frame information for updating an item on the board.
item_id	string	Yes	Unique identifier (ID) of the item that you want to update.
board_id	string	Yes	Unique identifier (ID) of the board where you want to update the item.
position	object	No	Position information for updating an item on the board.

Output

Name	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.

Update Shape Item

MIRO_UPDATE_SHAPE_ITEM

Tool to update an existing shape item on a Miro board. Use when you need to modify properties of a shape such as content, style, position, geometry, or parent. Include only the fields you want to change.

Input parameters

Name	Type	Required	Description
data	object	No	Core data for updating a shape item.
style	object	No	Styling options for updating a shape item.
parent	object	No	Parent item reference for updating a shape’s nesting.
item_id	string	Yes	Unique identifier of the shape item to update.
board_id	string	Yes	Unique identifier of the board containing the shape item.
geometry	object	No	Geometrical dimensions for updating a shape item.
position	object	No	Board position for updating a shape item.

Output

Name	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.

Update Sticky Note Item

MIRO_UPDATE_STICKY_NOTE_ITEM

Tool to update a sticky note item on a Miro board. Use when you need to modify the content, style, position, geometry, or parent of an existing sticky note.

Input parameters

Name	Type	Required	Description
data	object	No	Contains sticky note item data, such as the content or shape of the sticky note.
style	object	No	Contains information about the style of a sticky note item, such as the fill color or text alignment.
parent	object	No	Contains information about the parent frame for the item.
item_id	string	Yes	Unique identifier (ID) of the item that you want to update.
board_id	string	Yes	Unique identifier (ID) of the board where you want to update the item.
geometry	object	No	Contains geometrical information about the item. You can set either the width or height. You cannot set both the width and height at the same time.
position	object	No	Contains information about the item’s position on the board, such as its x coordinate, y coordinate.

Output

Name	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.

Update Tag

MIRO_UPDATE_TAG

Tool to update a tag on a board. Use when you need to modify a tag’s title or color. At least one field (title or fillColor) should be provided to update.

Input parameters

Name	Type	Required	Description
title	string	No	Text of the tag. Case-sensitive. Must be unique within the board.
tag_id	string	Yes	Unique identifier (ID) of the tag that you want to update.
board_id	string	Yes	Unique identifier (ID) of the board where you want to update a specific tag.
fillColor	string	No	Fill color for the tag. Options: red, light_green, cyan, yellow, magenta, green, blue, gray, violet, dark_green, dark_blue, black.

Output

Name	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.

Update Text Item

MIRO_UPDATE_TEXT_ITEM

Tool to update a text item on a Miro board. Use when you need to modify the content, style, position, or other properties of an existing text item.

Input parameters

Name	Type	Required	Description
data	object	No	Contains text item data to update.
style	object	No	Contains information about the style of a text item to update.
parent	object	No	Contains information about the parent frame for the item.
item_id	string	Yes	Unique identifier (ID) of the item that you want to update.
board_id	string	Yes	Unique identifier (ID) of the board where you want to update the item.
geometry	object	No	Contains geometrical information about the item to update.
position	object	No	Contains information about the item’s position on the board to update.

Output

Name	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.