Team
Shared credential for production and unattended runs.
Connect Miro with Hookshot™ and your stack
Miro is a collaborative online whiteboard enabling teams to brainstorm ideas, design wireframes, plan workflows, and manage projects visually
Tools and triggers
What Agents can do in Miro
Available tools and events after Miro is connected.
-
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…
-
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…
-
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…
-
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.
-
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…
-
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.
-
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.
-
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.
-
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).
-
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.
-
Create Image Item From URL
Creates 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…
-
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.
-
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.
-
Create Mind Map 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.
-
Create Shape Item
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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'."
-
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.
-
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.
-
Delete Group
Tool to delete a group from a board. Use when you need to remove a group and optionally its items.
-
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.
-
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.
-
Delete Mind Map 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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
Get App Card Item 2
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.
-
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.
-
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…
-
Get Boards V2
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.
-
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.
-
Get Connector
Tool to retrieve a specific connector by its ID. Use when you need details about an existing connector on a board.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
Get Items by Group ID
Tool 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.
-
Get Items Within Frame
Get 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…
-
Get Mind Map Node
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.
-
Get Mind Map 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.
-
Get oEmbed Data
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.
-
Get Organization Context
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…
-
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.
-
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.
-
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.
-
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.).
-
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.
-
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.
-
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.
-
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.
-
Remove Tag From Item
Tool to remove a tag from a specific item on a Miro board. Use when you need to disassociate a tag from an item after confirming the board, item, and tag IDs. This action removes the tag from only this specific item…
-
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…
-
Update App Card Item 2
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
Setup
Connect Miro in Hookshot™
Pick a scope, then confirm what can start a Protege and what it can do.
Trigger Access
What can start a Protege from this app.
Tool Access
What a Protege can do after it starts.
Connection scope
Prefer team for production.
Personal
Tied to one user—only when the workflow needs their account.
Chat
Team-scoped for supported chat surfaces.
Build with us
See Hookshot™ in your stack.
Request early access or book a live walkthrough with the team.
