Skip to main content
Miro logo
  • Category: team collaboration
  • Auth: OAUTH2
  • Composio-managed OAuth available? Yes
  • Tools: 89
  • Triggers: 0
  • Slug: MIRO
  • Version: 20261101_00

Tools

Slug: MIRO_ATTACH_TAG_TO_ITEMTool 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

string
required
Unique identifier of the tag to attach to the item.
string
required
Unique identifier of the item to attach the tag to. Card and sticky note items can have up to 8 tags.
string
required
Unique identifier of the board containing the item.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIRO_COPY_BOARDCreate a copy of an existing Miro board, optionally changing its name, description, policies, or destination team. Returns the new board, leaving the source board unchanged.

Input Parameters

string
Name for the new board. Omit to use Miro’s default (Untitled).
object
Permissions and sharing policies for the new board.
string
ID of the team where the copied board must be placed.
string
required
ID of the existing board to copy.
string
Description of the new board.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIRO_CREATE_APP_CARD_ITEMCreates an app card on a Miro board, with optional custom preview fields. The returned card ID is at the top level of the response.

Input Parameters

object
required
Payload data for the app card
object
Styling options for an app card item.
object
Parent frame reference for nesting an app card item.
string
required
ID of the board to add the app card to
object
Geometrical dimensions for an app card item.
object
Board position for an app card item.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIRO_CREATE_BOARDTool 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

string
required
Name for the board, length between 1 and 60 characters.
object
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.
string
Unique identifier (ID) of the team where the board will be created.
string
Unique identifier (ID) of the project (space) to which the board belongs.
string
Description of the board, length between 0 and 300 characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIRO_CREATE_CARD_ITEMTool 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

object
Core data for a card item.
object
Styling options for a card item.
object
Parent item reference for nesting a card.
string
required
Unique identifier of the board where the card will be created
object
Geometrical dimensions for a card item.
object
Board position for a card item.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIRO_CREATE_CONNECTORTool 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

string ("straight" | "elbowed" | "curved")
required
Shape/style of the connector line.
object
Visual styling properties for the connector line and caption.
object
required
Defines the ending point of the connector. Must specify either snapTo or position.
string
required
Unique identifier of the board where the connector will be created.
array
Array of caption objects to display text along the connector.
object
required
Defines the starting point of the connector. Must specify either snapTo or position.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIRO_CREATE_DOC_FORMAT_ITEMCreate a structured Markdown doc on a Miro board.

Input Parameters

object
Parent frame for the doc.
string
required
Markdown content for the doc.
string
required
Unique identifier of the board where the doc will be created.
object
Position for the doc on the board.
integer
Optional numeric content version. Miro’s live API rejects the documented string type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIRO_CREATE_DOCUMENT_ITEMTool 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

object
required
Contains the document URL and optional title.
object
Parent element reference for hierarchical positioning.
string
required
The unique identifier of the board where the document will be created.
object
Geometric properties with fixed aspect ratio for the document item.
object
Positioning information for the document item on the board.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIRO_CREATE_DOCUMENT_ITEM_USING_FILE_FROM_DEVICECreate a document item on a Miro board by uploading a document file, with optional title, position, geometry, and parent frame.

Input Parameters

object
Data containing document metadata like title.
object
Parent frame information for the item.
string
required
Unique identifier (ID) of the board where you want to create the item.
object
Geometrical information about the item.
object
Position information for the document item on the board.
object
required
Document file to upload. Maximum file size: 6 MB. Supported format: PDF.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIRO_CREATE_EMBED_ITEMTool 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

object
required
Contains information about the embed URL.
object
Parent element reference for hierarchical positioning.
string
required
Unique identifier (ID) of the board where you want to create the item.
object
Geometrical information about the embed item.
object
Positioning information for the embed item on the board.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIRO_CREATE_FRAME_ITEMTool to add a frame item to a Miro board. Use frames to group and organize diagram regions (e.g., swimlanes, sections, slides).

Input Parameters

object
required
Contains frame-specific properties like title and format. This field is required.
object
Styling options for a frame item.
object
Parent item reference for nesting a frame.
string
required
Unique identifier of the board where the frame will be added
object
Geometrical dimensions for a frame item.
object
Board position for a frame item.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIRO_CREATE_FRAME_ITEM2DEPRECATED: 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

object
required
Contains frame item data, such as the title, frame type, or frame format.
object
Styling options for a frame item.
string
required
Unique identifier (ID) of the board where you want to create a frame.
object
Geometrical dimensions for a frame item.
object
Board position for a frame item.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIRO_CREATE_GROUPTool 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

object
required
Contains the data with item IDs to be grouped.
string
required
Unique identifier (ID) of the board where the group will be created.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIRO_CREATE_IMAGE_ITEM_FROM_URLCreates an image item on a Miro board by providing a URL to a publicly accessible image. This action adds images from external URLs rather than uploading files from local storage. Use this action when you have an image hosted online (e.g., on a CDN, image hosting service, or public URL) and want to add it to a Miro board without downloading and re-uploading the file.

Input Parameters

object
required
Contains the image URL and optional title.
object
Parent item reference for nesting an image.
string
required
Unique identifier (ID) of the board where you want to create the image item.
object
Geometrical dimensions for an image item.
object
Board position for an image item.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIRO_CREATE_IMAGE_ITEM_USING_LOCAL_FILETool 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

object
Core data for an image item.
object
Parent item reference for nesting an image.
string
required
Unique identifier (ID) of the board where you want to create the image item.
object
Geometrical dimensions for an image item.
object
Board position for an image item.
object
required
Image file to upload. Supported formats: PNG, JPG, JPEG, GIF, SVG, etc.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIRO_CREATE_ITEMS_IN_BULKTool 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

array
required
List of items to create. You can create 1 to 20 items per request.
string
required
Unique identifier of the board where items will be created.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIRO_CREATE_MINDMAP_NODE_EXPERIMENTALTool 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

object
required
Core mind map node data including the node view with content.
string
required
Unique identifier (ID) of the board where you want to create the mind map node.
object
Geometry for the mind map node.
object
Position for the mind map node on the board.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIRO_CREATE_SHAPE_ITEMDEPRECATED: Use MIRO_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

object
required
Core shape data including content text and shape type.
object
Styling options for a shape item.
object
Parent item reference for nesting a shape.
string
required
Unique identifier of the board where the shape will be created.
object
Geometrical dimensions for a shape item.
object
Board position for a shape item.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIRO_CREATE_SHAPE_ITEM2Tool 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

object
Core data for a shape item.
object
Styling options for a shape item.
object
Parent frame information for the shape item.
string
required
Unique identifier (ID) of the board where you want to create the item.
object
Geometrical information about the shape item.
object
Position information for the shape item.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIRO_CREATE_STICKY_NOTE_ITEMTool 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

object
Contains sticky note item data, such as the content or shape of the sticky note.
object
Contains information about the style of a sticky note item, such as the fill color or text alignment.
object
Contains information about the parent frame for the item.
string
required
Unique identifier (ID) of the board where you want to create the item.
object
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.
object
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIRO_CREATE_TAGTool 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

string
required
Text of the tag. Case-sensitive. Must be unique within the board.
string
required
Unique identifier (ID) of the board where you want to create the tag.
string ("red" | "light_green" | "cyan" | "yellow" | "magenta" | "green" | "blue" | "gray" | "violet" | "dark_green" | "dark_blue" | "black")
Fill color for the tag. Choose from predefined color options. Defaults to ‘red’ if not specified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIRO_CREATE_TEXT_ITEMTool 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

object
required
Contains text item data, such as the content.
object
Styling options for a text item.
object
Parent item reference for nesting a text item.
string
required
Unique identifier (ID) of the board where you want to create the item.
object
Geometrical dimensions for a text item.
object
Board position for a text item.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIRO_DELETE_APP_CARD_ITEMTool 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

string
required
Unique identifier of the app card item to delete.
string
required
Unique identifier of the board containing the app card item.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIRO_DELETE_BOARDDelete a Miro board. On paid plans, deleted boards go to Trash and can be restored via the Miro UI within 90 days after deletion.

Input Parameters

string
required
Unique identifier of the board to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIRO_DELETE_CARD_ITEMTool 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

string
required
Unique identifier (ID) of the item that you want to delete.
string
required
Unique identifier (ID) of the board from which you want to delete the item.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIRO_DELETE_CONNECTORTool 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

string
required
Unique identifier (ID) of the board from which you want to delete the connector.
string
required
Unique identifier (ID) of the connector that you want to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIRO_DELETE_DOC_FORMAT_ITEMDelete a structured Miro doc format item from a board.

Input Parameters

string
required
Unique identifier of the doc format item to delete.
string
required
Unique identifier of the board containing the doc.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIRO_DELETE_DOCUMENT_ITEMTool 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

string
required
Unique identifier of the document item to delete.
string
required
Unique identifier of the board containing the document item.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIRO_DELETE_EMBED_ITEMTool 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

string
required
Unique identifier (ID) of the item that you want to delete.
string
required
Unique identifier (ID) of the board from which you want to delete the item.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIRO_DELETE_FRAME_ITEMTool 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

string
required
Unique identifier (ID) of the frame that you want to delete.
string
required
Unique identifier (ID) of the board from which you want to delete the frame.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIRO_DELETE_GROUPTool to delete a group from a board. Use when you need to remove a group and optionally its items.

Input Parameters

string
required
Unique identifier (ID) of the board.
string
required
Unique identifier (ID) of the group.
boolean
required
Indicates whether the items should be removed. Set to true to delete items in the group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIRO_DELETE_IMAGE_ITEMTool to delete an image item from a board. Use when you need to remove an image that is no longer needed.

Input Parameters

string
required
Unique identifier (ID) of the item that you want to delete.
string
required
Unique identifier (ID) of the board from which you want to delete the item.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIRO_DELETE_ITEMTool 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

string
required
Unique identifier of the item to delete.
string
required
Unique identifier of the board containing the item.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIRO_DELETE_MINDMAP_NODE_EXPERIMENTALTool 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

string
required
Unique identifier (ID) of the mind map node that you want to delete.
string
required
Unique identifier (ID) of the board from which you want to delete the mind map node.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIRO_DELETE_SHAPE_ITEMTool 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

string
required
Unique identifier (ID) of the item that you want to delete.
string
required
Unique identifier (ID) of the board from which you want to delete the item.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIRO_DELETE_STICKY_NOTE_ITEMTool 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

string
required
Unique identifier (ID) of the item that you want to delete.
string
required
Unique identifier (ID) of the board from which you want to delete the item.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIRO_DELETE_TAGTool 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

string
required
Unique identifier (ID) of the tag that you want to delete.
string
required
Unique identifier (ID) of the board where you want to delete a specific tag.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIRO_DELETE_TEXT_ITEMTool 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

string
required
Unique identifier (ID) of the item that you want to delete.
string
required
Unique identifier (ID) of the board from which you want to delete the item.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIRO_DOWNLOAD_DOCUMENT_RESOURCERetrieve signed URL metadata for a Miro document resource.

Input Parameters

string
required
Board ID containing the document resource.
string
required
Resource ID from documentUrl; this is not the document item ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIRO_DOWNLOAD_IMAGE_RESOURCERetrieve a Miro image resource as signed URL metadata or a downloaded file.

Input Parameters

string ("preview" | "original")
Image representation to retrieve.
string
required
Board ID containing the image resource.
boolean
When false, return short-lived signed URL metadata; when true, follow the provider redirect and return a downloadable file.
string
required
Resource ID from the imageUrl returned by an image item action; this is not the image item ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIRO_GET_ALL_GROUPSTool 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIRO_GET_APP_CARD_ITEM2Tool 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

string
required
Unique identifier (ID) of the item that you want to retrieve.
string
required
Unique identifier (ID) of the board from which you want to retrieve a specific item.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIRO_GET_BOARDDEPRECATED: 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

string
required
Unique identifier of the board to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIRO_GET_BOARD_ITEMSTool 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

string ("ai_generation_result" | "app_card" | "card" | "data_table_format" | "diagram" | "doc_format" | "document" | "embed" | "frame" | "image" | "mindmap_node" | "shape" | "sticky_note" | "text")
Filter by item type. Note: ‘connector’ is not supported; use the separate Get Connectors action instead.
integer
Maximum number of items to return per page (10-50)
string
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).
string
required
Unique identifier of the board to retrieve items from

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIRO_GET_BOARD_MEMBERSTool 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

integer
Number of results per page (max 50).
string
Cursor for pagination, used to retrieve subsequent pages.
string
required
Unique identifier of the board.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIRO_GET_BOARDSDEPRECATED: Use MIRO_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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIRO_GET_BOARDS2Tool 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

string
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).
integer
Maximum number of boards to retrieve (1-50). Default: 20
string
Retrieves a list of boards that belong to a specific owner ID. You must pass the owner ID (for example, 3074457353169356300), not the owner name. You can use the ‘owner’ parameter with the query parameter to narrow down the board search results. Note that if you pass the team_id in the same request, the owner parameter is ignored.
string
Retrieves a list of boards that contain the query string provided in the board name or board description. You can use the query parameter with the owner parameter to narrow down the board search results.
integer
Zero-based offset of the first item in the collection. Default: 0
string
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.
string
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIRO_GET_CARD_ITEMTool 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

string
required
Unique identifier (ID) of the item that you want to retrieve.
string
required
Unique identifier (ID) of the board from which you want to retrieve a specific item.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIRO_GET_CONNECTORTool to retrieve a specific connector by its ID. Use when you need details about an existing connector on a board.

Input Parameters

string
required
Unique identifier (ID) of the board from which you want to retrieve a specific connector.
string
required
Unique identifier (ID) of the connector that you want to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIRO_GET_CONNECTORSTool 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

integer
Maximum number of results to return per call (10 to 50). Defaults to 10.
string
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.
string
required
Unique identifier of the board to retrieve connectors from.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIRO_GET_DOC_FORMAT_ITEMRetrieve a structured Miro doc as Markdown or HTML.

Input Parameters

string
required
Unique identifier of the doc format item to retrieve.
string
required
Unique identifier of the board containing the doc.
string ("html" | "markdown")
Representation in which Miro should return the doc content.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIRO_GET_DOCUMENT_ITEMTool 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

string
required
Unique identifier (ID) of the item that you want to retrieve.
string
required
Unique identifier (ID) of the board from which you want to retrieve a specific item.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIRO_GET_EMBED_ITEMTool 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

string
required
Unique identifier (ID) of the item that you want to retrieve.
string
required
Unique identifier (ID) of the board from which you want to retrieve a specific item.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIRO_GET_FRAME_ITEMTool 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

string
required
Unique identifier (ID) of the frame that you want to retrieve.
string
required
Unique identifier (ID) of the board that contains the frame that you want to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIRO_GET_GROUP_BY_IDTool to retrieve a specific group by its ID. Use when you need to get details about a group on a Miro board.

Input Parameters

string
required
Unique identifier (ID) of the board.
string
required
Unique identifier (ID) of the group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIRO_GET_IMAGE_ITEMTool to retrieve a specific image item from a board. Use when you need to get details about an existing image item.

Input Parameters

string
required
Unique identifier (ID) of the item that you want to retrieve.
string
required
Unique identifier (ID) of the board from which you want to retrieve a specific item.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIRO_GET_ITEMS_BY_GROUP_IDTool to retrieve items of a specific group by its ID on a Miro board. Use when you need to fetch all items belonging to a particular group.

Input Parameters

integer
The maximum number of items to return at one time. Default is 10, minimum is 10, maximum is 50.
string
Cursor for paginating results; use the value from a prior response.
string
required
Unique identifier (ID) of the board.
string
required
The ID of the group item to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIRO_GET_ITEMS_WITHIN_FRAMEGet items within a specific frame on a Miro board. Retrieves child items contained within a frame by filtering with parent_item_id parameter. Use this action when you need to list all items (shapes, sticky notes, cards, etc.) that are nested inside a specific frame. This is useful for analyzing or processing frame contents.

Input Parameters

string ("text" | "shape" | "sticky_note" | "image" | "document" | "card" | "app_card" | "preview" | "frame" | "embed")
Enum for board item types.
integer
Maximum number of items to return per page (minimum 1)
string
Cursor for paginating results; use the value from a prior response
string
required
Unique identifier of the board containing the frame
string
required
ID of the frame (parent item) for which to retrieve child items

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIRO_GET_ITEM_TAGSTool 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

string
required
Unique identifier of the item to retrieve tags from.
string
required
Unique identifier of the board containing the item.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIRO_GET_MINDMAP_NODE_EXPERIMENTALTool 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

string
required
Unique identifier (ID) of the mind map node that you want to retrieve.
string
required
Unique identifier (ID) of the board from which you want to retrieve a mind map node.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIRO_GET_MINDMAP_NODES_EXPERIMENTALTool 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

string
Maximum number of results returned.
string
Points to the next portion of the results set. Use the cursor value from a previous response to retrieve the next page.
string
required
Unique identifier (ID) of the board from which you want to retrieve mind map nodes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIRO_GET_OEMBEDTool 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

string
required
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=).
string
Specifies the return format of the response. Only ‘json’ is supported. Defaults to ‘json’ if not specified.
integer
The maximum width available to the embed, in pixels. The oEmbed response will respect this constraint.
string
The URL pointing to the source of the request. Used to track where the embed will be displayed.
integer
The maximum height available to the embed, in pixels. The oEmbed response will respect this constraint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIRO_GET_SHAPE_ITEMTool 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

string
required
Unique identifier (ID) of the item that you want to retrieve.
string
required
Unique identifier (ID) of the board from which you want to retrieve a specific item.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIRO_GET_SPECIFIC_BOARDTool 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

string
required
Unique identifier (ID) of the board that you want to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIRO_GET_SPECIFIC_BOARD_MEMBERTool 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

string
required
Unique identifier (ID) of the board to which the board member belongs.
string
required
Unique identifier (ID) of the board member whose role you want to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIRO_GET_SPECIFIC_ITEMTool 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

string
required
Unique identifier (ID) of the item that you want to retrieve.
string
required
Unique identifier (ID) of the board from which you want to retrieve a specific item.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIRO_GET_STICKY_NOTE_ITEMTool 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

string
required
Unique identifier (ID) of the item that you want to retrieve.
string
required
Unique identifier (ID) of the board from which you want to retrieve a specific item.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIRO_GET_TAGTool 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

string
required
Unique identifier of the tag to retrieve.
string
required
Unique identifier of the board where the tag resides.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIRO_GET_TEXT_ITEMTool 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

string
required
Unique identifier (ID) of the item that you want to retrieve.
string
required
Unique identifier (ID) of the board from which you want to retrieve a specific item.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIRO_LIST_BOARD_TAGSTool 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

integer
Maximum number of tags to return per page (min 1).
string
Cursor for paginating results; use the value from a prior response.
string
required
Unique identifier of the board to retrieve tags from.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIRO_LIST_ORGANIZATIONSRetrieves 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIRO_REMOVE_BOARD_MEMBERRemove a member’s direct board membership. Team or public access may remain; this does not guarantee that the member loses all access to the board.

Input Parameters

string
required
Unique identifier of the board to remove the member from.
string
required
Unique identifier of the board member to remove.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIRO_REMOVE_TAG_FROM_ITEMRequests removal of a tag from a specified item on a Miro board. The request targets the item itself and may delete the item rather than only remove its tag.

Input Parameters

string
required
Unique identifier of the tag to remove from the item.
string
required
Unique identifier of the item to remove the tag from.
string
required
Unique identifier of the board containing the item.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIRO_SHARE_BOARDTool 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

string ("viewer" | "commenter" | "editor" | "coowner" | "owner")
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), or owner (full access including changing owner). Note: Inviting users with role ‘owner’ has the same effect as ‘coowner’.
array
required
Email addresses of the users you want to invite to the board. You can invite up to 20 members per call.
string
Optional message that will be sent in the invitation email to the invited users.
string
required
Unique identifier (ID) of the board to which you want to invite members.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIRO_UPDATE_APP_CARD_ITEM2Tool 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

object
Core data for an app card item.
object
Styling information for an app card item.
object
Parent frame information for an app card item.
string
required
Unique identifier (ID) of the item that you want to update.
string
required
Unique identifier (ID) of the board where you want to update the item.
object
Geometrical information about an app card item.
object
Position information for an app card item.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIRO_UPDATE_BOARDTool 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

string
New name for the board (1-60 characters)
object
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.
string
ID of the team where the board should be placed
string
required
Unique identifier (ID) of the board to update
string
ID of the project (space) to which the board should be added
string
New description for the board (up to 300 characters)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIRO_UPDATE_BOARD_MEMBERUpdates a specific board member’s role using the board and member IDs. If no role is supplied, the request sets it to commenter.

Input Parameters

string ("viewer" | "commenter" | "editor" | "coowner" | "owner")
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).
string
required
Unique identifier (ID) of the board for which you want to update the role of the board member.
string
required
Unique identifier (ID) of the board member whose role you want to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIRO_UPDATE_CARD_ITEMTool 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIRO_UPDATE_CONNECTORTool 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

string ("straight" | "elbowed" | "curved")
The path type of the connector line, defines curvature. Default: curved.
object
Visual styling properties for the connector line and caption.
object
Defines the starting or ending point of a connector.
string
required
Unique identifier (ID) of the board for which you want to update the connector.
array
Blocks of text you want to display on the connector. Maximum 20 captions allowed.
object
Defines the starting or ending point of a connector.
string
required
Unique identifier (ID) of the connector that you want to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIRO_UPDATE_DOCUMENT_ITEMTool 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

object
Data for document URL information.
object
Parent element reference for hierarchical positioning.
string
required
Unique identifier (ID) of the item that you want to update.
string
required
Unique identifier (ID) of the board where you want to update the item.
object
Geometric properties for the document item. You can set either width or height, not both.
object
Positioning information for the document item on the board.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIRO_UPDATE_EMBED_ITEMTool 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIRO_UPDATE_FRAME_ITEMTool 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

object
Core data for updating a frame item.
object
Styling options for updating a frame item.
string
required
Unique identifier (ID) of the frame that you want to update.
string
required
Unique identifier (ID) of the board where you want to update the frame.
object
Geometrical dimensions for updating a frame item.
object
Board position for updating a frame item.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIRO_UPDATE_GROUPTool 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

object
required
Contains the data with item IDs to be included in the group.
string
required
Unique identifier (ID) of the board.
string
required
Unique identifier (ID) of the group to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIRO_UPDATE_IMAGE_ITEMTool 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIRO_UPDATE_ITEM_POSITION_OR_PARENTTool 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

object
Parent frame information for updating an item on the board.
string
required
Unique identifier (ID) of the item that you want to update.
string
required
Unique identifier (ID) of the board where you want to update the item.
object
Position information for updating an item on the board.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIRO_UPDATE_SHAPE_ITEMTool 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

object
Core data for updating a shape item.
object
Styling options for updating a shape item.
object
Parent item reference for updating a shape’s nesting.
string
required
Unique identifier of the shape item to update.
string
required
Unique identifier of the board containing the shape item.
object
Geometrical dimensions for updating a shape item.
object
Board position for updating a shape item.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIRO_UPDATE_STICKY_NOTE_ITEMTool 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

object
Contains sticky note item data, such as the content or shape of the sticky note.
object
Contains information about the style of a sticky note item, such as the fill color or text alignment.
object
Contains information about the parent frame for the item.
string
required
Unique identifier (ID) of the item that you want to update.
string
required
Unique identifier (ID) of the board where you want to update the item.
object
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.
object
Contains information about the item’s position on the board, such as its x coordinate, y coordinate.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIRO_UPDATE_TAGTool 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

string
Text of the tag. Case-sensitive. Must be unique within the board.
string
required
Unique identifier (ID) of the tag that you want to update.
string
required
Unique identifier (ID) of the board where you want to update a specific tag.
string ("red" | "light_green" | "cyan" | "yellow" | "magenta" | "green" | "blue" | "gray" | "violet" | "dark_green" | "dark_blue" | "black")
Fill color for the tag. Choose from predefined color options.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIRO_UPDATE_TEXT_ITEMTool 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

object
Contains text item data to update.
object
Contains information about the style of a text item to update.
object
Contains information about the parent frame for the item.
string
required
Unique identifier (ID) of the item that you want to update.
string
required
Unique identifier (ID) of the board where you want to update the item.
object
Contains geometrical information about the item to update.
object
Contains information about the item’s position on the board to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not