Miro API
Tools that enable LLMs to interact directly with the miro API.
Arcade Toolkit integrates with the Miro API, allowing developers to enhance collaborative functionalities within Miro boards. It empowers applications to add, update, or delete board items effectively while maintaining user engagement.
Capabilities
- Automated addition and management of various items on Miro boards.
- Streamlined updates to existing board elements, such as shapes and text items.
- Efficient retrieval of board details and user activities for oversight.
- Integration with enterprise project management features.
OAuth
- Provider: Miro
- Scopes: boards:write, projects:write
Secrets
- No secret types or names required for this toolkit.
Available tools(139)
| Tool name | Description | Secrets | |
|---|---|---|---|
Add an app card item to a specified board on Miro.
Use this tool to add an app card item to a Miro board. Must have 'boards:write' scope permission. Appropriate for situations requiring interaction with Miro boards to add app-specific information cards.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
This operation also requires path parameters.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
Note: You must also provide the required path parameters when executing.
If you need the schema, call with mode='get_request_schema' ONCE, then execute.
| |||
Add a frame to a Miro board.
Use this tool to add a new frame item to a specified Miro board. It requires the 'boards:write' scope to operate and adheres to Level 2 rate limiting. | |||
Add a card item to a Miro board.
Use this tool to create and add a new card item to a specified Miro board. This is useful for organizing tasks, notes, or ideas visually within a board. Ensure you have the required 'boards:write' scope for authorization.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
This operation also requires path parameters.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
Note: You must also provide the required path parameters when executing.
If you need the schema, call with mode='get_request_schema' ONCE, then execute.
| |||
Adds a connector to a specified Miro board.
Use this tool to add a connector to a specified Miro board. Requires 'boards:write' scope and is subject to Level 2 rate limiting.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
This operation also requires path parameters.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
Note: You must also provide the required path parameters when executing.
If you need the schema, call with mode='get_request_schema' ONCE, then execute.
| |||
Add a document to a Miro board using its URL.
This tool adds a document as an item to a specified Miro board by providing the document's URL. It's useful for organizing resources in a collaborative board. Requires 'boards:write' scope and observes Level 2 rate limiting. | |||
Add an embed item with external content to a Miro board.
Use this tool to add external content as an embed item to a specific board on Miro. Requires 'boards:write' scope and is subject to rate limiting. | |||
Add a flowchart shape item to a Miro board.
Use this tool to add a flowchart shape to a specific Miro board. This enables users to programmatically enhance their boards with flowchart items, requiring write access to the board. It's ideal for automating workflows or integrating with other tools that require visualization updates in Miro.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
This operation also requires path parameters.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
Note: You must also provide the required path parameters when executing.
If you need the schema, call with mode='get_request_schema' ONCE, then execute.
| |||
Add an image to a Miro board using a URL.
This tool is used to add an image to a specific Miro board by providing an image URL. It requires the 'boards:write' scope for authorization. Ideal for users who want to enhance their Miro boards with visual content by specifying image links. | |||
Add up to 20 items to a Miro board in one transaction.
Use this tool to add multiple items like shapes, cards, and sticky notes to a Miro board in one operation. The operation is transactional; if adding any item fails, no items will be added. Suitable for enhancing board content efficiently.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
This operation also requires path parameters.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
Note: You must also provide the required path parameters when executing.
If you need the schema, call with mode='get_request_schema' ONCE, then execute.
| |||
Add a new mind map node to a Miro board.
This tool adds a new node to a mind map on a Miro board. It can create root or child nodes with specified x, y coordinates for positioning. Use it when you want to expand a mind map with additional nodes on a specified board. | |||
Add a user to an Enterprise Miro project.
Use this tool to add a Miro user to a project under the Enterprise plan. Requires 'projects:write' scope and Company Admin role. | |||
Add a shape to a Miro board.
This tool is used to add a new shape item to a specified board on Miro. It requires valid board access permissions and helps in organizing visual content on the board.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
This operation also requires path parameters.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
Note: You must also provide the required path parameters when executing.
If you need the schema, call with mode='get_request_schema' ONCE, then execute.
| |||
Add a sticky note to a Miro board.
Use this tool to create and add a sticky note item to a specified Miro board. This requires board write permissions and is subject to Level 2 rate limiting.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
This operation also requires path parameters.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
Note: You must also provide the required path parameters when executing.
If you need the schema, call with mode='get_request_schema' ONCE, then execute.
| |||
Add a text item to a specified Miro board.
This tool adds a text item to a specified Miro board using the 'boards:write' scope. It's useful when you want to insert text elements into a Miro board for collaboration or documentation purposes. Ensure you have the necessary permissions and adhere to rate limits (Level 2).
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
This operation also requires path parameters.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
Note: You must also provide the required path parameters when executing.
If you need the schema, call with mode='get_request_schema' ONCE, then execute.
| |||
Attach a tag to a specific item on a Miro board.
Use this tool to attach an existing tag to a specified item, such as a card or sticky note, on a Miro board. Note that updates to tags via the API will require a board refresh to be visible. | |||
Create a copy of an existing Miro board.
This tool creates a duplicate of an existing Miro board, allowing updates to the board's name, description, sharing policy, and permissions. It requires the 'boards:write' scope and complies with level 4 rate limiting.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
This operation also requires query parameters.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
Note: You must also provide the required query parameters when executing.
If you need the schema, call with mode='get_request_schema' ONCE, then execute.
| |||
Initiates an export job for specified boards in an organization.
This tool creates an export job for one or more boards within Miro, available exclusively to Enterprise plan users with Company Admin roles and eDiscovery enabled. It's suitable for managing board exports, optimizing data handling within an organization. | |||
Subscribe to board update notifications via webhook.
Creates a webhook subscription to get notifications when an item on a board is updated. Suitable for monitoring changes on a board except for tags, connectors, and comments. Requires 'boards:read' scope. | |||
Create a tag on a Miro board.
This tool is used to create a tag on a specified Miro board. It should be called when there's a need to organize or categorize elements on a board by adding a new tag. | |||
Create a new project within an enterprise team on Miro.
Use this tool to create a project in an existing team for Enterprise plan users on Miro. Projects help organize boards and manage user access for groups within a team. This tool requires Company Admin access on an Enterprise plan. | |||
Creates a new team in an existing Miro organization.
This tool is used to create a new team within an existing organization in Miro. It is specifically available for Enterprise plan users who are Company Admins. This tool requires the 'organizations:teams:write' scope. | |||
Creates a group of items on a Miro board.
This tool creates a group consisting of specified items on a Miro board. It should be used when you want to organize multiple items into a group on a board. Requires 'boards:write' scope. | |||
Create a new board on Miro with specific settings.
This tool allows you to create a new board in Miro by specifying its name and sharing policies. It is limited to creating up to 3 team boards for users on the free plan. Ensure you have the required 'boards:write' scope.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
If you need the schema, call with mode='get_request_schema' ONCE, then execute. | |||
Delete an app card item from a Miro board.
Use this tool to delete a specific app card item from a Miro board. It's required when a card needs to be removed, ensuring the board is updated accordingly. | |||
Delete a specific connector from a board.
Use this tool to delete a specified connector from a Miro board. It requires write access to boards and is subject to Level 3 rate limiting. |
Selected tools
No tools selected.
Click "Show all tools" to add tools.
Requirements
Select tools to see requirements
MiroApi.AddAppCardToBoard
Add an app card item to a specified board on Miro. Use this tool to add an app card item to a Miro board. Must have 'boards:write' scope permission. Appropriate for situations requiring interaction with Miro boards to add app-specific information cards. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
board_identifier | string | Optional | Unique identifier (ID) of the Miro board where the app card will be added. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'create-app-card-item'.MiroApi.AddBoardFrame
Add a frame to a Miro board. Use this tool to add a new frame item to a specified Miro board. It requires the 'boards:write' scope to operate and adheres to Level 2 rate limiting.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
board_id | string | Required | Unique identifier of the board where the frame will be created. |
frame_fill_color | string | Optional | Specify the fill color for the frame using hex values. Supported colors include: `#f5f6f8`, `#d5f692`, `#d0e17a`, `#93d275`, `#67c6c0`, `#23bfe7`, `#a6ccf5`, `#7b92ff`, `#fff9b1`, `#f5d128`, `#ff9d48`, `#f16c7f`, `#ea94bb`, `#ffcee0`, `#b384bb`, `#000000`. The default is transparent (`#ffffffff`). |
frame_format | string | Optional | Specify the format for the frame. Only 'custom' is supported. |
frame_height_pixels | number | Optional | Specify the height of the frame in pixels on the Miro board. |
frame_title | string | Optional | Title of the frame to appear at the top. It must be a string. |
frame_type | string | Optional | Specify the type of frame to create. Only 'freeform' is supported at the moment. |
frame_width_in_pixels | number | Optional | Specify the width of the frame in pixels. |
position_y_coordinate | number | Optional | Y-axis coordinate for the frame's position on the board. Default is `0`. Center of the board has `x: 0` and `y: 0`. |
reveal_frame_content | boolean | Optional | Set to true to reveal content inside the frame; false to hide it. Applicable for Enterprise plans only. |
x_axis_position_on_board | number | Optional | X-axis coordinate for placing the frame on the board. Default is 0, where the center is at x: 0. |
Requirements
Output
json— Response from the API endpoint 'create-frame-item'.MiroApi.AddCardToMiroBoard
Add a card item to a Miro board. Use this tool to create and add a new card item to a specified Miro board. This is useful for organizing tasks, notes, or ideas visually within a board. Ensure you have the required 'boards:write' scope for authorization. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
miro_board_id | string | Optional | Unique identifier (ID) of the Miro board where you want to add the card item. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'create-card-item'.MiroApi.AddConnectorToBoard
Adds a connector to a specified Miro board. Use this tool to add a connector to a specified Miro board. Requires 'boards:write' scope and is subject to Level 2 rate limiting. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
board_unique_id | string | Optional | Unique identifier for the Miro board where the connector will be added. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'create-connector'.MiroApi.AddDocumentToBoardByUrl
Add a document to a Miro board using its URL. This tool adds a document as an item to a specified Miro board by providing the document's URL. It's useful for organizing resources in a collaborative board. Requires 'boards:write' scope and observes Level 2 rate limiting.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
board_identifier | string | Required | Unique identifier (ID) of the Miro board where the document will be added. |
document_title | string | Optional | A short text header to identify the document added to the board. |
document_url | string | Optional | The URL where the document is hosted. This URL is required to add the document to the Miro board. |
item_height_in_pixels | number | Optional | Specifies the height of the item on the board in pixels. |
item_width_in_pixels | number | Optional | Specify the width of the document item on the board in pixels. |
parent_frame_id | string | Optional | Unique identifier of the parent frame for the document item on the board. |
position_x_coordinate | number | Optional | X-axis coordinate for placing the item on the board. Defaults to `0`. Center of board is `0`. |
rotation_angle_degrees | number | Optional | Specify the rotation angle of the document item in degrees. Use positive values for clockwise rotation and negative for counterclockwise. |
y_axis_coordinate_on_board | number | Optional | Y-axis coordinate for placing the document on the Miro board. Defaults to `0`, where `0` is the center of the board. |
Requirements
Output
json— Response from the API endpoint 'create-document-item-using-url'.MiroApi.AddEmbedItemToBoard
Add an embed item with external content to a Miro board. Use this tool to add external content as an embed item to a specific board on Miro. Requires 'boards:write' scope and is subject to rate limiting.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
board_identifier | string | Required | Unique identifier of the board where you want to create the embed item. |
content_display_mode | string | Optional | Specify how the embedded content is displayed on the board. Options are 'inline' for direct display and 'modal' for modal overlay. |
content_url | string | Optional | A valid URL pointing to the content resource to embed in the board. Supports HTTP and HTTPS. |
embed_item_width_pixels | number | Optional | Width of the embed item in pixels. Defines the size of the item on the board. |
item_height | number | Optional | Specify the height of the embedded item, in pixels. |
parent_frame_id | string | Optional | Unique identifier (ID) of the parent frame for the item on the Miro board. |
preview_image_url | string | Optional | URL of the image used as the preview for the embedded item. |
x_coordinate_on_board | number | Optional | X-axis coordinate for the item's location on the board. Default is 0, with absolute positioning relative to the board center. |
y_axis_coordinate_on_board | number | Optional | Y-axis coordinate for placing the item on the board. Default is 0, with (0, 0) as the board's center. |
Requirements
Output
json— Response from the API endpoint 'create-embed-item'.MiroApi.AddFlowchartShapeToBoard
Add a flowchart shape item to a Miro board. Use this tool to add a flowchart shape to a specific Miro board. This enables users to programmatically enhance their boards with flowchart items, requiring write access to the board. It's ideal for automating workflows or integrating with other tools that require visualization updates in Miro. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
board_identifier | string | Optional | The unique ID of the Miro board where the flowchart shape will be added. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'create-shape-item-flowchart'.MiroApi.AddImageToMiroBoard
Add an image to a Miro board using a URL. This tool is used to add an image to a specific Miro board by providing an image URL. It requires the 'boards:write' scope for authorization. Ideal for users who want to enhance their Miro boards with visual content by specifying image links.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
board_unique_identifier | string | Required | The unique identifier for the board where the image will be added. |
image_height_pixels | number | Optional | Height of the image in pixels to be added to the Miro board. |
image_title | string | Optional | A short text header to identify the image on the Miro board. |
image_url | string | Optional | URL of the image to be added to the Miro board. |
image_width_pixels | number | Optional | The width of the image in pixels to be added to the board. |
parent_frame_id | string | Optional | Unique identifier for the parent frame where the image will be added. Use this to specify a frame within the board if needed. |
rotation_angle_degrees | number | Optional | Rotation angle of the image, in degrees, relative to the board. Use positive for clockwise and negative for counterclockwise. |
x_axis_coordinate | number | Optional | X-axis coordinate for the image location on the Miro board. Center is at x: 0. Default is 0. |
y_axis_coordinate | number | Optional | Y-axis coordinate of the item's location on the board. Default is 0, centered on the board. |
Requirements
Output
json— Response from the API endpoint 'create-image-item-using-url'.MiroApi.AddItemsToMiroBoard
Add up to 20 items to a Miro board in one transaction. Use this tool to add multiple items like shapes, cards, and sticky notes to a Miro board in one operation. The operation is transactional; if adding any item fails, no items will be added. Suitable for enhancing board content efficiently. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
miro_board_identifier | string | Optional | The unique identifier of the Miro board where items will be created. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'create-items'.MiroApi.AddMindmapNode
Add a new mind map node to a Miro board. This tool adds a new node to a mind map on a Miro board. It can create root or child nodes with specified x, y coordinates for positioning. Use it when you want to expand a mind map with additional nodes on a specified board.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
board_id | string | Required | Unique identifier (ID) of the board where the new mind map node will be created. |
mindmap_node_content | string | Optional | The text content to display within the mind map node. |
node_type | string | Optional | Specifies the type of mind map node. Use 'text' as the current valid type. |
node_width_pixels | number | Optional | Width of the mind map node in pixels. Specifies how wide the node will appear on the board. |
parent_frame_id | string | Optional | Unique identifier (ID) of the parent node or frame for the mind map node. |
x_coordinate | number | Optional | X-axis coordinate for node placement on the board. Defaults to `0`, placing the node at the center along the x-axis. |
y_coordinate | number | Optional | Y-coordinate for item placement on the board. Defaults to 0 if not specified, placing it at the board's center. |
Requirements
Output
json— Response from the API endpoint 'create-mindmap-nodes-experimental'.MiroApi.AddMiroProjectMember
Add a user to an Enterprise Miro project. Use this tool to add a Miro user to a project under the Enterprise plan. Requires 'projects:write' scope and Company Admin role.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_id | string | Required | The ID of the organization to which the project belongs. |
project_id | string | Required | The unique ID of the Miro project to which a user will be added. |
project_member_role | string | Required | Role of the user to be assigned in the Miro project. Possible values: owner, editor, viewer, commentator, coowner. |
team_id | string | Required | The ID of the team to which the project belongs. Used to identify the specific team for project member addition. |
user_email_id | string | Required | The email address of the user to be added as a project member. |
Requirements
Output
json— Response from the API endpoint 'enterprise-add-project-member'.MiroApi.AddShapeToMiroBoard
Add a shape to a Miro board. This tool is used to add a new shape item to a specified board on Miro. It requires valid board access permissions and helps in organizing visual content on the board. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
board_id | string | Optional | Unique identifier of the Miro board where the shape will be added. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'create-shape-item'.MiroApi.AddStickyNoteToBoard
Add a sticky note to a Miro board. Use this tool to create and add a sticky note item to a specified Miro board. This requires board write permissions and is subject to Level 2 rate limiting. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
board_id | string | Optional | Unique identifier of the board where the sticky note will be added. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'create-sticky-note-item'.MiroApi.AddTextToMiroBoard
Add a text item to a specified Miro board. This tool adds a text item to a specified Miro board using the 'boards:write' scope. It's useful when you want to insert text elements into a Miro board for collaboration or documentation purposes. Ensure you have the necessary permissions and adhere to rate limits (Level 2). Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
board_identifier | string | Optional | The unique ID of the Miro board where the text item will be created. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'create-text-item'.MiroApi.AttachTagToItem
Attach a tag to a specific item on a Miro board. Use this tool to attach an existing tag to a specified item, such as a card or sticky note, on a Miro board. Note that updates to tags via the API will require a board refresh to be visible.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
board_id | string | Required | Unique ID of the board where the item to tag is located. |
item_identifier | string | Required | Unique identifier of the item to which you want to add a tag on the Miro board. |
tag_id | string | Required | Unique identifier of the tag to attach to the item. |
Requirements
Output
json— Response from the API endpoint 'attach-tag-to-item'.MiroApi.CopyMiroBoard
Create a copy of an existing Miro board. This tool creates a duplicate of an existing Miro board, allowing updates to the board's name, description, sharing policy, and permissions. It requires the 'boards:write' scope and complies with level 4 rate limiting. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
source_board_id | string | Optional | Unique identifier (ID) of the board that you want to copy. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'copy-board'.MiroApi.CreateBoardExportJob
Initiates an export job for specified boards in an organization. This tool creates an export job for one or more boards within Miro, available exclusively to Enterprise plan users with Company Admin roles and eDiscovery enabled. It's suitable for managing board exports, optimizing data handling within an organization.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
board_export_request_id | string | Required | A unique identifier for the export job, used to track the export process of boards in Miro. |
organization_id | string | Required | Unique identifier of the organization for exporting boards. |
export_board_ids | array<string> | Optional | A list of board IDs to be exported. Provide the IDs as an array of strings. |
export_format | string | Optional | Specifies the format for exporting the board. Options: SVG (default), HTML, or PDF. |
Requirements
Output
json— Response from the API endpoint 'enterprise-create-board-export'.MiroApi.CreateBoardSubscription
Subscribe to board update notifications via webhook. Creates a webhook subscription to get notifications when an item on a board is updated. Suitable for monitoring changes on a board except for tags, connectors, and comments. Requires 'boards:read' scope.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
board_id | string | Optional | Unique identifier of the board to associate with the webhook subscription. |
webhook_callback_url | string | Optional | The HTTPS URL where Miro sends a webhook upon an event occurrence. This URL must be accessible by Miro to receive notifications. |
webhook_status | string | Optional | Set the status of the webhook subscription. Use 'enabled' to receive notifications, 'disabled' to stop notifications, or 'lost_access' if access to the board is lost. |
Requirements
Output
json— Response from the API endpoint 'create-board-subscription'.MiroApi.CreateBoardTag
Create a tag on a Miro board. This tool is used to create a tag on a specified Miro board. It should be called when there's a need to organize or categorize elements on a board by adding a new tag.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
board_unique_id | string | Required | The unique identifier (ID) of the Miro board where the tag will be created. |
tag_title | string | Required | Unique, case-sensitive text for the tag. |
tag_fill_color | string | Optional | The fill color of the tag. Choose from options: red, light_green, cyan, yellow, magenta, green, blue, gray, violet, dark_green, dark_blue, black. |
Requirements
Output
json— Response from the API endpoint 'create-tag'.MiroApi.CreateEnterpriseProject
Create a new project within an enterprise team on Miro. Use this tool to create a project in an existing team for Enterprise plan users on Miro. Projects help organize boards and manage user access for groups within a team. This tool requires Company Admin access on an Enterprise plan.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_id | string | Required | The unique ID of the organization where you want to create a project on Miro. |
project_name | string | Required | The name of the project to be created within the team. It should be descriptive and unique for easy identification. |
team_id | string | Required | The unique ID of the team where the project will be created. |
Requirements
Output
json— Response from the API endpoint 'enterprise-create-project'.MiroApi.CreateEnterpriseTeam
Creates a new team in an existing Miro organization. This tool is used to create a new team within an existing organization in Miro. It is specifically available for Enterprise plan users who are Company Admins. This tool requires the 'organizations:teams:write' scope.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_id | string | Required | The unique identifier for the organization where the team is being created. |
team_name | string | Optional | The name of the team to be created within the organization. |
Requirements
Output
json— Response from the API endpoint 'enterprise-create-team'.MiroApi.CreateGroupOnBoard
Creates a group of items on a Miro board. This tool creates a group consisting of specified items on a Miro board. It should be used when you want to organize multiple items into a group on a board. Requires 'boards:write' scope.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
board_identifier | string | Required | The unique string identifier of the Miro board where the group will be created. |
item_ids | array<string> | Optional | An array of unique identifiers (IDs) for the items to be grouped on the board. Each ID corresponds to an item you wish to include in the group. |
Requirements
Output
json— Response from the API endpoint 'createGroup'.MiroApi.CreateMiroBoard
Create a new board on Miro with specific settings. This tool allows you to create a new board in Miro by specifying its name and sharing policies. It is limited to creating up to 3 team boards for users on the free plan. Ensure you have the required 'boards:write' scope. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'create-board'.MiroApi.DeleteAppCardFromBoard
Delete an app card item from a Miro board. Use this tool to delete a specific app card item from a Miro board. It's required when a card needs to be removed, ensuring the board is updated accordingly.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
board_id | string | Required | Unique identifier (ID) of the board from which to delete an app card item. |
item_id | string | Required | Unique identifier (ID) of the item to delete from the board. |
Requirements
Output
json— Response from the API endpoint 'delete-app-card-item'.MiroApi.DeleteBoardConnector
Delete a specific connector from a board. Use this tool to delete a specified connector from a Miro board. It requires write access to boards and is subject to Level 3 rate limiting.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
board_unique_identifier | string | Required | Unique identifier (ID) of the board from which you want to delete the connector. |
connector_id | string | Required | Unique identifier of the connector to delete from the board. |
Requirements
Output
json— Response from the API endpoint 'delete-connector'.MiroApi.DeleteBoardFrame
Delete a frame from a Miro board. Use this tool to delete a specific frame from a Miro board. Call this when you need to remove frame items identified by their board and item IDs. Requires 'boards:write' permission scope.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
board_id | string | Required | The unique ID of the Miro board from which you want to delete the frame. |
frame_id | string | Required | Unique identifier of the frame to be deleted from the board. |
Requirements
Output
json— Response from the API endpoint 'delete-frame-item'.MiroApi.DeleteBoardGroup
Delete a group and its items from a Miro board. This tool removes a specified group and all its contained items from a Miro board. Use it when you need to clean up or reorganize board content by deleting groups. Ensure you have the necessary permissions to modify the board.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
board_id | string | Required | Unique identifier of the board from which the group will be deleted. |
delete_items_with_group | boolean | Required | Set to true to delete items within the group when deleting the group from the board. |
group_id | string | Required | Unique identifier (ID) of the group to be deleted. |
Requirements
Output
json— Response from the API endpoint 'deleteGroup'.MiroApi.DeleteBoardImage
Deletes an image item from a Miro board. Use this tool to delete an image from a specific Miro board by providing the board ID and image item ID. Ensure you have the required 'boards:write' scope.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
board_identifier | string | Required | Unique identifier of the board from which to delete the image item. Required for deleting the image. |
image_item_id | string | Required | Unique identifier of the image item to delete from the board. |
Requirements
Output
json— Response from the API endpoint 'delete-image-item'.MiroApi.DeleteBoardItem
Deletes an item from a Miro board. Use this tool to delete an item from a Miro board. It requires the 'boards:write' scope and is subject to Level 3 rate limiting. Ideal for managing board content.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
board_id | string | Required | Unique identifier (ID) of the board from which you want to delete the item. |
item_id | string | Required | Unique identifier (ID) of the item to delete from the board. |
Requirements
Output
json— Response from the API endpoint 'delete-item'.MiroApi.DeleteBoardTag
Delete a tag from a Miro board and its items. This tool deletes a specified tag from a Miro board and removes it from all cards and sticky notes on the board. Note that changes via the API are not reflected in real-time and require a board refresh to update visually.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
board_identifier | string | Required | Unique ID of the board from which to delete a specific tag. |
tag_id_to_delete | string | Required | Unique identifier of the tag that you want to delete from the board. |
Requirements
Output
json— Response from the API endpoint 'delete-tag'.MiroApi.DeleteCardItem
Deletes a card item from the Miro board. Use this tool to delete a specific card item from a Miro board when its removal is required. It operates with 'boards:write' scope permissions and is subject to Level 3 rate limiting.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
board_identifier | string | Required | Unique identifier of the board from which the card item should be deleted. |
item_id | string | Required | The unique identifier of the card item to be deleted from the board. |
Requirements
Output
json— Response from the API endpoint 'delete-card-item'.MiroApi.DeleteDocumentItemFromBoard
Deletes a document item from a Miro board. Use this tool to delete a specific document item from a Miro board. Ideal for cleaning up or managing board content. Requires 'boards:write' scope for permission.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
board_id | string | Required | The unique ID of the Miro board to delete the document item from. |
item_id | string | Required | Unique identifier of the item to delete from the board. |
Requirements
Output
json— Response from the API endpoint 'delete-document-item'.MiroApi.DeleteEnterpriseProject
Delete a project while retaining associated boards and users. Use this tool to delete a project in an enterprise Miro account. This action retains all boards and users under the same team. It requires 'projects:write' scope and is available only for enterprise users with Company Admin role.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_id | string | Required | The ID of the organization from which you want to delete a project. |
project_id_to_delete | string | Required | The ID of the project that needs to be deleted from the organization. |
team_id | string | Required | The unique identifier of the team from which the project is to be deleted. |
Requirements
Output
json— Response from the API endpoint 'enterprise-delete-project'.MiroApi.DeleteEnterpriseTeam
Deletes an existing team for enterprise users. This tool deletes a specific team within an enterprise organization, available only to users with Enterprise plans and a Company Admin role. It should be used when there's a need to remove an entire team from an organization's Miro account.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_id | string | Required | The unique identifier for the organization. Required to specify which organization's team is to be deleted. |
team_id | string | Required | The unique identifier for the team to be deleted within the organization. |
Requirements
Output
json— Response from the API endpoint 'enterprise-delete-team'.MiroApi.DeleteFlowchartShape
Delete a flowchart shape from a Miro board. Use this tool to delete a specific flowchart shape item from a Miro board by specifying the board and item identifiers.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
board_unique_id | string | Required | Unique identifier of the board from which to delete the shape item. |
item_id | string | Required | Unique identifier of the flowchart shape item to delete from the board. |
Requirements
Output
json— Response from the API endpoint 'delete-shape-item-flowchart'.MiroApi.DeleteMindmapNode
Delete a mind map node and its child nodes from the board. Use this tool to delete a specified mind map node and all its child nodes from a Miro board. This is suitable for when you need to clear or restructure parts of a mind map on the board. Requires 'boards:write' permission scope.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
board_identifier | string | Required | Unique identifier (ID) of the board from which the mind map node will be deleted. |
mindmap_node_id | string | Required | The unique ID of the mind map node to delete, including all child nodes, from the board. |
Requirements
Output
json— Response from the API endpoint 'delete-mindmap-node-experimental'.MiroApi.DeleteMiroBoard
Delete a Miro board and move it to Trash. Use this tool to delete a Miro board. Deleted boards on paid plans are moved to Trash and can be restored via the UI within 90 days. Requires 'boards:write' scope.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
board_identifier | string | Required | Unique identifier of the Miro board to be deleted. Must be a valid string ID. |
Requirements
Output
json— Response from the API endpoint 'delete-board'.MiroApi.DeleteMiroWebhookSubscription
Delete a Miro webhook subscription by ID. Use this tool to delete a specific webhook subscription on Miro by providing its ID. This operation requires 'boards:read' scope and is subject to Level 2 rate limiting.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
subscription_id | string | Required | The unique identifier (ID) for the Miro subscription to delete. |
Requirements
Output
json— Response from the API endpoint 'delete-subscription-by-id'.MiroApi.DeleteShapeFromMiroBoard
Delete a shape item from a Miro board. Use this tool to delete a specific shape item from a Miro board using the board and item IDs. Ensure you have the necessary permissions and consider rate limits.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
board_id | string | Required | Unique identifier of the board from which you want to delete the shape item. |
item_id | string | Required | Unique identifier (ID) of the shape item to delete from the Miro board. |
Requirements
Output
json— Response from the API endpoint 'delete-shape-item'.MiroApi.DeleteStickyNote
Deletes a sticky note from a Miro board. Call this tool to remove a specific sticky note from a given Miro board by specifying the board and item IDs. Ensure you have the necessary 'boards:write' scope.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
board_id | string | Required | Unique identifier (ID) of the board from which you want to delete the sticky note. |
sticky_note_id | string | Required | Unique identifier (ID) of the sticky note you want to delete from the board. |
Requirements
Output
json— Response from the API endpoint 'delete-sticky-note-item'.MiroApi.FetchBoardContentChanges
Fetches content changes for board items in your organization. Use this tool to retrieve content changes made to board items in your organization, including updates, creations, and deletions by users. You can filter the results by time period, board IDs, and user emails, and paginate the data for processing. Note: This tool is for Enterprise plan users and requires Company Admin role.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
end_modification_datetime | string | Required | Specify the end date and time for filtering content logs based on when a board item was last modified. Use UTC format adhering to ISO 8601 with a trailing Z offset. |
organization_id | string | Required | A string representing the unique identifier of the organization required for fetching board content changes. |
start_date_time | string | Required | Specify the start date and time for filtering content logs, in UTC format (ISO 8601 with trailing Z). |
board_ids | array<string> | Optional | List of board IDs for retrieving content logs. Provide as an array of strings. |
max_results_per_call | integer | Optional | The maximum number of results to return per call. If exceeded, a cursor is provided for pagination. |
pagination_cursor | string | Optional | Cursor for pagination to fetch the next set of results. Use the cursor value from the previous response to continue retrieving paginated results. |
sort_order_by_date | string | Optional | Specify 'asc' for ascending or 'desc' for descending sort order based on modified date. |
user_email_filter | array<string> | Optional | Filter content logs based on the list of emails of users who created, modified, or deleted board items. |
Requirements
Output
json— Response from the API endpoint 'enterprise-board-content-item-logs-fetch'.MiroApi.GetAccessTokenInfo
Retrieve detailed information about an access token. Use this tool to get information about an OAuth access token, including its type, scopes, associated team, user details, creation date and time, and the creator's identity.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'token-info'.MiroApi.GetAppUsageMetrics
Retrieve usage metrics for a specific app over a time range. This tool is used to obtain usage metrics for a specific app within a defined time period. It requires an app management API token and the 'boards:read' scope. Useful for monitoring app performance and usage patterns.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
application_id | string | Required | The ID of the app to retrieve metrics for. Provide a valid app ID to obtain usage data. |
end_date | string | Required | End date of the period in UTC format, e.g., 2024-12-31. |
start_date_utc | string | Required | Start date of the period in UTC format (e.g., 2024-12-31). |
group_data_by_period | string | Optional | Specify the time period for grouping data: 'DAY', 'WEEK', or 'MONTH'. |
Requirements
Output
json— Response from the API endpoint 'get-metrics'.MiroApi.GetBoardClassificationSettings
Retrieve board classification settings for an organization. Use this tool to get the board classification settings of an existing organization within the Miro Enterprise plan. This is applicable only for Company Admins. Ensure you have the required 'organizations:read' scope and be aware of rate limits.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_id | string | Required | The unique string ID of the organization for which to retrieve board classification settings. |
Requirements
Output
json— Response from the API endpoint 'enterprise-dataclassification-organization-settings-get'.MiroApi.GetBoardConnectors
Retrieve connectors for a specified board on Miro. This tool retrieves a list of connectors for a specific board on Miro using a cursor-based approach. Useful for obtaining details about board connectors, with pagination support for large sets.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
board_identifier | string | Required | Unique identifier for the Miro board to retrieve connectors from. Required for identifying the specific board. |
pagination_cursor | string | Optional | Cursor pointing to the next set of results for paginated requests. Use this to retrieve subsequent pages. |
result_limit | string | Optional | Specifies the maximum number of connectors to retrieve in one call. This assists in pagination of connector data. |
Requirements
Output
json— Response from the API endpoint 'get-connectors'.MiroApi.GetBoardFrameInfo
Retrieve information about a specific frame on a board. Use this tool to get detailed information about a specific frame within a Miro board. Useful for accessing frame-specific data when managing or viewing board content.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
board_unique_id | string | Required | Unique identifier of the board containing the frame to retrieve. |
frame_id | string | Required | Unique identifier (ID) of the frame to retrieve from the board. |
Requirements
Output
json— Response from the API endpoint 'get-frame-item'.MiroApi.GetBoardGroups
Retrieve all groups and their items from a specific board. Use this tool to get all the groups along with their respective items from a given board in Miro. The data is retrieved using a cursor-based pagination method. To fetch the next set of results, use the cursor value from the previous response.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
board_id | string | Required | Unique identifier of the Miro board to retrieve groups from. |
max_items_to_return | integer | Optional | The maximum number of items to return at once. Default is 10 and the maximum is 50. |
next_page_cursor | string | Optional | The cursor value for fetching the next set of group items from the board. Use it to paginate results. |
Requirements
Output
json— Response from the API endpoint 'get-all-groups'.MiroApi.GetBoardItemInfo
Retrieve information for a specific item on a Miro board. Use this tool to get detailed information about a specific item on a Miro board using the provided board and item IDs.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
board_identifier | string | Required | Unique identifier of the board to retrieve the specific item from. |
item_identifier | string | Required | Unique identifier of the item to retrieve from the board. |
Requirements
Output
json— Response from the API endpoint 'get-specific-item'.MiroApi.GetBoardItems
Retrieve items from a specific Miro board. This tool retrieves items from a specific Miro board. It can fetch all items, child items within a parent, or specific types of items using query parameters. Results are paginated; use the cursor value from the previous response to get the next set of items.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
board_identifier | string | Required | Unique identifier of the Miro board to retrieve items from. |
item_type | string | Optional | Specify the type of items to retrieve from the board, such as 'shape'. |
pagination_cursor | string | Optional | The cursor value to retrieve the next set of items from a board. Use the value returned in the previous response to paginate through results. |
pagination_limit | string | Optional | The maximum number of items to return in a single call. Use this to control the size of the result set per request. |
Requirements
Output
json— Response from the API endpoint 'get-items-experimental'.MiroApi.GetBoardMemberInfo
Retrieve details about a specific board member. Use this tool to get information about a specific member of a Miro board, including details necessary for collaboration and management. This should be called when you need to access a board member's data for a given board on Miro.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
board_id | string | Required | Unique identifier (ID) of the board to which the board member belongs. |
board_member_id | string | Required | Unique identifier (ID) of the board member whose role you want to retrieve on a specific board. |
Requirements
Output
json— Response from the API endpoint 'get-specific-board-member'.MiroApi.GetBoardTags
Retrieve all tags from a specified Miro board. Use this tool to get all the tags associated with a specific board in Miro. It helps in organizing and filtering board elements by tags.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
board_id | string | Required | The unique identifier of the board to retrieve tags from. This is required to specify the target board in Miro. |
maximum_number_of_tags | string | Optional | Specifies the maximum number of tags to retrieve from the board. |
result_offset | string | Optional | Specifies the starting point for the result set to retrieve tags, useful for pagination. |
Requirements
Output
json— Response from the API endpoint 'get-tags-from-board'.MiroApi.GetCardItemInfo
Retrieve details about a specific card item from a Miro board. Use this tool to obtain information on a specific card item located on a Miro board. Ideal for accessing card details with read permissions on boards.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
board_identifier | string | Required | Unique identifier of the board to retrieve the specific card item from. |
item_unique_id | string | Required | Unique identifier of the item to retrieve from the board. |
Requirements
Output
json— Response from the API endpoint 'get-card-item'.MiroApi.GetDefaultTeamSettings
Retrieve default team settings for an organization. This tool retrieves the default team settings for an existing organization within the Enterprise plan on Miro. It requires 'organizations:teams:read' scope and is accessible only to Company Admins.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_id | string | Required | The unique identifier for an Organization within Miro's Enterprise plan. Required for retrieving default team settings. |
Requirements
Output
json— Response from the API endpoint 'enterprise-get-default-team-settings'.MiroApi.GetEmbedItemInfo
Retrieve details of an embed item on a Miro board. Use this tool to obtain information about a specific embed item on a Miro board. It's ideal when you need to fetch details of an embedded component such as a document or link integrated into a board. Ensure the board's read permissions are granted.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
board_identifier | string | Required | Unique identifier (ID) of the Miro board from which to retrieve the embed item. |
embed_item_id | string | Required | Unique identifier of the embed item to retrieve from the board. |
Requirements
Output
json— Response from the API endpoint 'get-embed-item'.MiroApi.GetEnterpriseTeamMembers
Retrieve team members for an enterprise organization team. This tool retrieves the list of team members for a specific team within an enterprise organization on Miro. It should be used when needing to access the team member details for organizational purposes. This tool is only available to users with an Enterprise plan and the role of Company Admin.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_id | string | Required | The unique identifier for the organization whose team members are being retrieved. |
team_identifier | string | Required | The unique identifier for the team whose members are being retrieved. |
filter_by_role | string | Optional | Filter team members by their role. Accepted values: 'member', 'admin', 'non_team', 'team_guest'. |
member_retrieval_limit | integer | Optional | The maximum number of team members to retrieve in one call. Leave empty for default. |
pagination_cursor | string | Optional | Indicates the page position for fetching results. Leave empty for the first page or use the value from the previous cursor field for subsequent pages. |
Requirements
Output
json— Response from the API endpoint 'enterprise-get-team-members'.MiroApi.GetEnterpriseTeams
Retrieve list of teams in an enterprise organization. This tool is used to obtain a list of teams for a given organization in the Enterprise plan of Miro. It requires the user to have the role of a Company Admin and proper authorization scopes. It is essential for enterprises needing to manage or view their organizational structure.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_id | string | Required | The unique identifier of the organization to retrieve teams from. |
maximum_results_limit | integer | Optional | The maximum number of team records to retrieve. If not set, defaults to the API's default value. |
pagination_cursor | string | Optional | Indicator for page position in results. Leave empty for first page; use previous cursor for next pages. |
team_name_filter | string | Optional | Filters teams by name using case insensitive partial match. For example, 'dev' will return both 'Developer's team' and 'Team for developers'. |
Requirements
Output
json— Response from the API endpoint 'enterprise-get-teams'.MiroApi.GetExportJobStatus
Retrieve the status of a Miro board export job. This tool checks the status of a board export job for Miro Enterprise plan users. It requires the user to be a Company Admin with eDiscovery enabled. Access is limited to users with the appropriate role and access privileges.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
board_export_job_id | string | Required | Unique identifier for the Miro board export job. |
organization_id | string | Required | Unique identifier for the Miro organization. Required for retrieving the export job status. |
Requirements
Output
json— Response from the API endpoint 'enterprise-board-export-job-status'.MiroApi.GetGroupItemsMiro
Retrieve items from a specific group on a Miro board. Call this tool to fetch a list of items within a specific group on a Miro board, identified by board_id and group_id. Useful for accessing group content details.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
board_unique_identifier | string | Required | Unique identifier for the Miro board to fetch group items from. |
group_id | string | Required | Unique identifier of the group to retrieve items from on the board. |
Requirements
Output
json— Response from the API endpoint 'getGroupById'.MiroApi.GetImageItemInfo
Fetches details for a specified image item on a Miro board. Use this tool to retrieve detailed information for a specific image item within a Miro board. It requires the board ID and image item ID to access the data.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
board_unique_id | string | Required | Unique identifier of the board to retrieve a specific image item from. |
image_item_id | string | Required | Unique identifier of the image item to retrieve from the board. |
Requirements
Output
json— Response from the API endpoint 'get-image-item'.MiroApi.GetItemsByGroupId
Retrieve items from a specific group on a Miro board. This tool retrieves a list of items that belong to any group within a specified Miro board. It uses a cursor-based pagination method to manage large sets of results. Use this tool to explore group-contained items on Miro boards when you have the appropriate board access permissions.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
board_identifier | string | Required | Unique identifier (ID) of the Miro board to retrieve items from. |
group_item_id | string | Required | The ID of the group item to retrieve from the board. |
max_items_per_request | integer | Optional | The maximum number of items to return per request. Default is 10, maximum is 50. |
next_cursor | string | Optional | A string used for cursor-based pagination to fetch the next set of results. Set it to the value received from the previous API response to continue retrieving items. |
Requirements
Output
json— Response from the API endpoint 'getItemsByGroupId'.MiroApi.GetItemsWithinFrame
Retrieve items within a specified frame on a Miro board. Use this tool to get a list of items located within a specific frame on a Miro board. It's useful for accessing grouped content within frames. The tool supports paginated results, using a cursor to fetch subsequent portions of data if the frame contains more items than the specified limit.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
board_id | string | Required | Unique identifier (ID) of the board containing the frame to retrieve items from. |
frame_id | string | Required | The ID of the frame from which you want to retrieve the items. Required to locate the parent frame on the board. |
item_retrieval_limit | string | Optional | Specifies the maximum number of items to return in one call. Used for pagination purposes. |
item_type_filter | string | Optional | Specify the type of items to retrieve within the frame. Leave blank to retrieve all types. |
pagination_cursor | string | Optional | A string used for cursor-based pagination to fetch the next set of results. |
Requirements
Output
json— Response from the API endpoint 'get-items-within-frame'.MiroApi.GetMindmapNodes
Retrieve mind map nodes from a specified Miro board. Use this tool to fetch a list of mind map nodes from a particular Miro board. Ideal for accessing structured information stored in mind maps. Requires board ID to specify the target board and supports cursor-based pagination for large datasets.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
board_identifier | string | Required | The unique identifier for the Miro board to retrieve mind map nodes from. This ID specifies the target board. |
maximum_results_limit | string | Optional | Specifies the maximum number of mind map nodes returned in the response. Use this to control pagination and limit the data load. |
pagination_cursor | string | Optional | A string that points to the next portion of the results set for cursor-based pagination. |
Requirements
Output
json— Response from the API endpoint 'get-mindmap-nodes-experimental'.MiroApi.GetMiroBoardMembers
Retrieve members of a Miro board. This tool retrieves a pageable list of members for a specified Miro board. It should be called when you need to access information about who is part of a specific board. Ensure that the required scope 'boards:read' is authorized to use this tool.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
board_id | string | Required | Unique identifier (ID) of the Miro board whose members are to be retrieved. |
number_of_members_to_retrieve | string | Optional | Specify the maximum number of board members to retrieve. This limits the number of results returned in one call. |
pagination_offset | string | Optional | Specifies the starting point of the list of board members to return, for pagination purposes. |
Requirements
Output
json— Response from the API endpoint 'get-board-members'.MiroApi.GetMiroMindmapNode
Retrieve details about a specific mind map node on a Miro board. Use this tool to get information about a particular node within a mind map on a Miro board. Useful for understanding node details or extracting specific data related to mind map elements.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
board_id | string | Required | Unique identifier (ID) of the Miro board to retrieve a mind map node from. |
mindmap_node_id | string | Required | Unique identifier of the mind map node to retrieve from the board. |
Requirements
Output
json— Response from the API endpoint 'get-mindmap-node-experimental'.MiroApi.GetMiroProjectInfo
Retrieve information for a specific Miro project. This tool retrieves information about a specific project in Miro, such as the project name. It is intended for users with Enterprise plans and requires the 'projects:read' scope. Use this tool when you need to view details of a specific project as an Enterprise user.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_id | string | Required | The ID of the organization to retrieve project information. |
project_identifier | string | Required | The unique ID of the project to retrieve information for. |
team_id_for_project_info | string | Required | The ID of the team from which you want to retrieve the project information. |
Requirements
Output
json— Response from the API endpoint 'enterprise-get-project'.MiroApi.GetMiroSubscriptionInfo
Fetch detailed information for a specific Miro subscription. Use this tool to retrieve detailed information about a specific webhook subscription in Miro. It's useful for checking the status or configuration of a particular subscription. Requires 'boards:read' scope for access.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
subscription_id | string | Required | Unique identifier of the Miro subscription to retrieve. |
Requirements
Output
json— Response from the API endpoint 'get-subscription-by-id'.MiroApi.GetOrganizationInfo
Retrieve detailed information about a specific organization. This tool fetches organization information for Enterprise plan users with the role of Company Admin. It requires the 'organizations:read' scope. Rate limiting is at Level 3.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_id | string | Required | The unique identifier for the organization to retrieve information for. This is required to access the organization's details. |
Requirements
Output
json— Response from the API endpoint 'enterprise-get-organization'.MiroApi.GetOrganizationMemberInfo
Retrieve details about a specific organization member. This tool retrieves information about a member of an organization within Miro. It's designed for use by users on the Enterprise plan with the role of Company Admin. Useful for obtaining member-specific information for administrative tasks.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_id | string | Required | The unique identifier for the organization whose member info is being retrieved. |
organization_member_id | string | Required | ID of the organization member to retrieve information for. |
Requirements
Output
json— Response from the API endpoint 'enterprise-get-organization-member'.MiroApi.GetOrganizationMembers
Retrieve organization members using organization ID or emails. This tool retrieves members of an organization in Miro based on the provided organization ID and cursor, or user emails. It requires the 'organizations:read' scope and is accessible only to Enterprise plan users with Company Admin roles.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_id | string | Required | The unique identifier for the organization to retrieve members from. Required for the operation. |
include_only_active_members | boolean | Optional | Set to true to include only active members in the response. Set to false to include all members, regardless of their status. |
license_type | string | Optional | Defines the type of license for the organization members to filter (e.g., full, occasional, free). |
member_role_filter | string | Optional | Filter organization members by role, such as 'organization_internal_admin' or 'organization_external_user'. |
pagination_cursor | string | Optional | String value for pagination to retrieve the next set of results in a multi-page response. |
result_limit | integer | Optional | Specifies the maximum number of organization members to retrieve. |
user_emails | string | Optional | A comma-separated string of user emails to filter organization members. |
Requirements
Output
json— Response from the API endpoint 'enterprise-get-organization-members'.MiroApi.GetProjectMemberInfo
Retrieve information about a specific project member. This tool retrieves detailed information for a specific project member within an organization. It should be called by users with Enterprise plan access and the role of Company Admin. The information is essential for managing project members and understanding their roles and contributions in a team environment.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
member_id | string | Required | The ID of the project member to retrieve specific information. |
organization_id | string | Required | The ID of the organization to which the project belongs. |
project_identifier | string | Required | The ID of the project to get information about a specific member. |
team_identifier | string | Required | The ID of the team to which the project belongs. |
Requirements
Output
json— Response from the API endpoint 'enterprise-get-project-member'.MiroApi.GetProjectMembers
Retrieve members of a specific project. Fetches the list of members involved in a specific project. Available only for Enterprise plan users with Company Admin role. Requires 'projects:read' scope.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_id | string | Required | The ID of the organization to which the project belongs. |
project_identifier | string | Required | The unique identifier of the project to retrieve its members. |
team_id | string | Required | The unique ID of the team associated with the project. |
maximum_results_per_call | integer | Optional | Specifies the maximum number of project members to return per call. Additional results can be accessed via the cursor parameter. |
pagination_cursor | string | Optional | Indicator for the page position in the result set. Leave empty for the first page; use the prior response's cursor for next pages. |
Requirements
Output
json— Response from the API endpoint 'enterprise-get-project-members'.MiroApi.GetProjectSettings
Retrieve enterprise project settings for a specific project. This tool retrieves the settings of a specific project within an enterprise account on Miro. It is available only to Enterprise plan users with Company Admin roles. The tool should be called to obtain project-related configuration details, ensuring an understanding of current project settings.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_id | string | Required | The unique ID of the organization to which the project belongs. |
project_id | string | Required | The ID of the project for which you want to retrieve the project settings. |
team_id | string | Required | The ID of the team to which the project belongs. Must be a valid team ID within the organization. |
Requirements
Output
json— Response from the API endpoint 'enterprise-get-project-settings'.MiroApi.GetRecentAuditLogs
Retrieve recent audit logs from the last 90 days. This tool retrieves a page of audit events from Miro for the last 90 days, useful for monitoring and reviewing recent activities. For older data, refer to the CSV export feature.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
end_date_for_audit_logs | string | Required | Retrieve audit logs created before this date and time. Format: UTC ISO 8601, including milliseconds and trailing Z. |
start_date_time_for_audit_logs | string | Required | Retrieve audit logs created after the specified UTC start date and time in ISO 8601 format, including milliseconds and 'Z'. |
maximum_results_limit | integer | Optional | Specify the maximum number of audit logs to retrieve in a single request. Defaults to 100 if not specified. Use a smaller number to limit the results or manage pagination efficiently. |
pagination_cursor | string | Optional | Cursor value for paginating through audit log results. Use the value returned in the previous response to obtain the next set of results. |
sort_order | string | Optional | Specifies the sort order for viewing audit logs: 'ASC' for ascending or 'DESC' for descending. |
Requirements
Output
json— Response from the API endpoint 'enterprise-get-audit-logs'.MiroApi.GetShapeInformation
Retrieve detailed information about a specific shape on a Miro board. Use this tool to obtain detailed information for a particular shape item on a Miro board. Useful for accessing shape attributes and configurations when given the board and item IDs.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
board_identifier | string | Required | Unique identifier (ID) of the Miro board from which to retrieve a specific shape item. |
shape_item_id | string | Required | Unique identifier of the shape item to retrieve from the Miro board. |
Requirements
Output
json— Response from the API endpoint 'get-shape-item'.MiroApi.GetStickyNoteInfo
Retrieve details of a sticky note from a Miro board. This tool retrieves information about a specific sticky note on a Miro board, using the provided board and item IDs.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
miro_board_id | string | Required | The unique identifier of the Miro board to retrieve the sticky note item from. |
sticky_note_id | string | Required | Specify the unique ID of the sticky note to retrieve from the board. |
Requirements
Output
json— Response from the API endpoint 'get-sticky-note-item'.MiroApi.GetTagInfo
Retrieve detailed information for a specific tag on a Miro board. Use this tool to obtain information about a specific tag associated with a Miro board. Useful for tasks requiring tag metadata or management on boards.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
board_id | string | Required | Unique identifier (ID) of the board from which to retrieve the specific tag. |
tag_identifier | string | Required | Unique identifier of the tag to retrieve from the board. |
Requirements
Output
json— Response from the API endpoint 'get-tag'.MiroApi.GetTagsFromItem
Retrieve all tags from a specified item on a board. Use this tool to get a list of all tags associated with a specific item on a Miro board. This requires read access to the board via the appropriate scope and is subject to Level 1 rate limiting.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
board_identifier | string | Required | Unique identifier (ID) of the board containing the item for which tags are to be retrieved. |
item_identifier | string | Required | Unique identifier (ID) of the item whose tags are to be retrieved from the board. |
Requirements
Output
json— Response from the API endpoint 'get-tags-from-item'.MiroApi.GetTeamBoardClassificationSettings
Retrieve board classification settings for an enterprise team. Use this tool to get the board classification settings of an existing team within an enterprise organization. Ideal for enterprise plan users with Company Admin roles wishing to check data classification details.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_id | string | Required | The unique identifier for the organization. Required for retrieving team settings. |
team_identifier | string | Required | ID of the team whose board classification settings you want to retrieve. Must be a string. |
Requirements
Output
json— Response from the API endpoint 'enterprise-dataclassification-team-settings-get'.MiroApi.GetTeamInfo
Retrieve information about an existing team within an organization. This tool retrieves information about a specific team for users with Enterprise plan access on Miro. It requires the 'organizations:teams:read' scope and is available only to Company Admins. It should be called when detailed information about a team is needed.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_id | string | Required | The unique identifier for the organization in Miro. |
team_id | string | Required | The unique identifier of the team to retrieve information for. This is required to specify which team within the organization you're inquiring about. |
Requirements
Output
json— Response from the API endpoint 'enterprise-get-team'.MiroApi.GetTeamProjects
Fetches projects from a specified team within an organization. Use this tool to retrieve a list of all projects, including private ones, from a team in an organization. It requires Content Admin permissions and is available only to Enterprise plan users with Company Admin roles.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_id | string | Required | The ID of the organization to retrieve the list of available projects from. |
team_id | string | Required | The ID of the team from which to retrieve the list of projects. This is required to specify which team's projects to fetch. |
max_results_per_call | integer | Optional | The maximum number of projects to return in one call. Use this to control the size of the dataset returned. If exceeded, a cursor for pagination will be provided. |
pagination_cursor | string | Optional | Used to navigate through pages of results. Leave empty for the first page; set to the value from the previous response for subsequent pages. |
Requirements
Output
json— Response from the API endpoint 'enterprise-get-projects'.MiroApi.GetTeamSettings
Fetches settings for a specific team in an organization. This tool retrieves team settings for a specified team within an organization in Miro. It is applicable only to users with the Enterprise plan who have the role of a Company Admin. Use this when you need detailed configuration information about a team.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_id | string | Required | The unique identifier for the organization. |
team_id | string | Required | The unique identifier for the team whose settings you want to retrieve. |
Requirements
Output
json— Response from the API endpoint 'enterprise-get-team-settings'.MiroApi.GetTextItemInfo
Retrieve details of a text item from a Miro board. Use this tool to get information about a specific text item on a Miro board, identified by board and item IDs.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
board_id | string | Required | Unique identifier (ID) of the board to retrieve a specific text item from. Required for identifying the board within Miro. |
text_item_id | string | Required | Unique identifier (ID) of the text item to retrieve from the board. |
Requirements
Output
json— Response from the API endpoint 'get-text-item'.MiroApi.GetUserWebhookSubscriptions
Retrieve all webhook subscriptions for a Miro user. Use this tool to obtain details about webhook subscriptions associated with a specific Miro user. Useful for managing or inspecting active webhooks. Requires 'boards:read' scope and adheres to Level 4 rate limiting.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
pagination_cursor | string | Optional | A string token used to paginate through webhook subscriptions. If not provided, retrieves the first page. |
subscription_limit | string | Optional | Specify the maximum number of webhook subscriptions to retrieve for the user. |
Requirements
Output
json— Response from the API endpoint 'get-user-subscriptions'.MiroApi.InviteMiroTeamMember
Invite a new user to a Miro team within your organization. Use this tool to invite an existing Miro organization member to an existing team. Suitable for Enterprise plan users with Company Admin roles. Ensure compliance with required authorization scopes and rate limiting.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_id | string | Required | The unique identifier for the Miro organization to which the user belongs. |
team_identifier | string | Required | Specify the unique identifier of the team within the organization. |
user_email_for_team_invitation | string | Required | Email address of the user to be invited to the Miro team. Ensure the email belongs to a user in your Miro organization. |
team_member_role | string | Optional | Specify the role for the team member: 'member', 'admin', or 'team_guest'. Determines access and permissions in the team. |
Requirements
Output
json— Response from the API endpoint 'enterprise-invite-team-member'.MiroApi.RemoveBoardItem
Delete an item from a Miro board. This tool deletes a specified item from a given Miro board. It requires the board's ID and the item's ID. This operation should be called when an item needs to be permanently removed from a board.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
board_unique_id | string | Required | Unique identifier of the Miro board to delete the item from. |
item_id | string | Required | Unique identifier (ID) of the item to delete from the board. |
Requirements
Output
json— Response from the API endpoint 'delete-item-experimental'.MiroApi.RemoveBoardMember
Remove a member from a Miro board. Use this tool to remove a specific member from a Miro board. This action requires 'boards:write' scope. Useful for managing board access and maintaining privacy.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
board_member_id | string | Required | Unique identifier of the board member to be removed from the board. |
board_unique_id | string | Required | Unique identifier of the board from which the member will be removed. |
Requirements
Output
json— Response from the API endpoint 'remove-board-member'.MiroApi.RemoveBoardTextItem
Delete a text item from a Miro board. Use this tool to delete a specific text item from a board in Miro. Requires 'boards:write' scope. It's useful when you need to remove unwanted or obsolete text content from your boards.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
board_identifier | string | Required | Unique identifier of the board from which the text item will be deleted. |
text_item_id | string | Required | Unique identifier (ID) of the text item to delete from the board. |
Requirements
Output
json— Response from the API endpoint 'delete-text-item'.MiroApi.RemoveEmbedItemFromBoard
Remove an embed item from a Miro board. This tool deletes a specific embed item from a Miro board. It should be called when there's a need to remove an embedded element from a board, such as cleaning up or updating board contents.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
board_identifier | string | Required | Unique identifier (ID) of the board from which the embed item will be deleted. |
item_id_to_delete | string | Required | Unique identifier of the embed item to be deleted from the board. |
Requirements
Output
json— Response from the API endpoint 'delete-embed-item'.MiroApi.RemoveProjectMember
Remove a member from a Miro project. This tool removes a specified member from a project within Miro. The user remains part of the team despite being removed from the project. This action is exclusive to Enterprise plan users with Company Admin roles.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
member_id | string | Required | The ID of the member to be removed from the project. |
organization_id | string | Required | The ID of the organization to which the project belongs. |
project_identifier | string | Required | The unique identifier for the project from which to remove a member. This ID is required to specify the project accurately. |
team_id | string | Required | The ID of the team to which the project belongs, required for specifying the project context. |
Requirements
Output
json— Response from the API endpoint 'enterprise-delete-project-member'.MiroApi.RemoveTagFromItem
Remove a specified tag from an item on a Miro board. Use this tool to remove a specific tag from an item on a Miro board. The tag will still exist on the board, but it will no longer be associated with the item. Note that changes will not reflect in real-time on the board unless refreshed.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
board_id_for_tag_removal | string | Required | Unique identifier (ID) of the board from which the tag will be removed from an item. |
item_id | string | Required | Unique identifier (ID) of the item from which the tag will be removed. |
tag_unique_identifier | string | Required | Unique identifier (ID) of the tag you want to remove from the item on the board. |
Requirements
Output
json— Response from the API endpoint 'remove-tag-from-item'.MiroApi.RemoveTeamMember
Remove a team member from a team by ID within an enterprise. This tool deletes a team member from a specified team using their ID within an enterprise, requiring admin permissions and appropriate API access scope.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_id | string | Required | The unique identifier of the organization from which a team member will be removed. |
team_identifier | string | Required | The unique identifier of the team from which the member will be removed. This should be a string representing the Team ID. |
team_member_id | string | Required | The unique identifier of the team member to be removed. |
Requirements
Output
json— Response from the API endpoint 'enterprise-delete-team-member'.MiroApi.ResetUserSessions
Reset all active Miro sessions for a specific user. This tool is used to immediately end all active Miro sessions for a specified user across all devices, requiring them to sign in again. It's useful for security reasons, such as when credentials are compromised or there's suspicious activity. This API is enterprise-only and requires admin privileges.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
user_email_for_session_reset | string | Required | Email ID of the user whose sessions need resetting. This will sign the user out from all devices. |
Requirements
Output
json— Response from the API endpoint 'enterprise-post-user-sessions-reset'.MiroApi.RetrieveAppCardInfo
Retrieve information for a specific Miro app card item. This tool retrieves detailed information about a specified app card item on a Miro board. Use it to access app card data when you have the board and item identifiers.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
board_identifier | string | Required | The unique ID for the board containing the app card item to retrieve. |
item_identifier | string | Required | Unique identifier of the app card item to retrieve from the board. |
Requirements
Output
json— Response from the API endpoint 'get-app-card-item'.MiroApi.RetrieveAppMetrics
Retrieve total usage metrics for a specific app. This tool retrieves total usage metrics for a specified app since its creation. It requires an app management API token and the appropriate scope. Useful for monitoring app usage and performance.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
app_id | string | Required | The unique identifier of the app to retrieve total usage metrics for. |
Requirements
Output
json— Response from the API endpoint 'get-metrics-total'.MiroApi.RetrieveBoardClassification
Get the data classification of a Miro board. Use this tool to retrieve the classification of a board within Miro. This is available for Enterprise plan users with Company Admin roles. It requires the 'boards:read' scope and is subject to Level 2 rate limiting.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
board_identifier | string | Required | Unique identifier for the Miro board to retrieve classification. |
organization_id | string | Required | The unique identifier of the organization for which you want to retrieve the board classification. |
team_id | string | Required | The unique identifier of the team to fetch the board classification from. |
Requirements
Output
json— Response from the API endpoint 'enterprise-dataclassification-board-get'.MiroApi.RetrieveBoardConnectorInfo
Retrieve information for a specific board connector. Use this tool to get detailed information about a specific connector on a Miro board. Ideal for extracting connector details when analyzing or processing board components.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
board_unique_identifier | string | Required | Unique identifier for the Miro board from which to retrieve the connector. |
connector_unique_id | string | Required | Unique identifier (ID) of the connector to retrieve from a Miro board. |
Requirements
Output
json— Response from the API endpoint 'get-connector'.MiroApi.RetrieveBoardInfo
Retrieve details of a specific Miro board. Retrieve detailed information about a specific board in Miro, including metadata and content, using the board's unique identifier.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
board_unique_identifier | string | Required | Unique identifier (ID) of the board to retrieve information from Miro. |
Requirements
Output
json— Response from the API endpoint 'get-specific-board'.MiroApi.RetrieveBoardItemInfo
Retrieve details for a specific board item on Miro. This tool retrieves information for a specific item on a Miro board. It should be called when you need details about an item identified by its board and item identifiers. Useful for accessing content or metadata of a board item.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
board_identifier | string | Required | Unique identifier of the Miro board to retrieve a specific item from. |
item_id | string | Required | Unique identifier of the item to retrieve from the board. |
Requirements
Output
json— Response from the API endpoint 'get-specific-item-experimental'.MiroApi.RetrieveBoardItems
Retrieve items from a specific Miro board. Use this tool to get a list of items from a Miro board. You can retrieve all items, child items, or specific types of items. Results are retrieved using a cursor-based pagination system.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
board_identifier | string | Required | Unique identifier (ID) of the Miro board to retrieve items from. |
item_type_filter | string | Optional | Specify the type of items to retrieve from the board (e.g., 'text', 'shape', 'sticky_note'). |
items_limit | string | Optional | The maximum number of items to retrieve from the board at once, using pagination. |
pagination_cursor | string | Optional | A string token used for cursor-based pagination to fetch the next set of results. |
Requirements
Output
json— Response from the API endpoint 'get-items'.MiroApi.RetrieveCaseInfo
Retrieve detailed information about an organization's case. Use this tool to obtain information about a specific case within an organization. Suitable for Enterprise plan users with required admin roles.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
case_id | string | Required | The unique ID of the case to retrieve information for. |
organization_id | string | Required | The unique ID of the organization whose case information you want to retrieve. |
Requirements
Output
json— Response from the API endpoint 'get-case'.MiroApi.RetrieveDocumentItemInfo
Retrieve information for a specific document item on a board. Use this tool to obtain details about a specific document item on a Miro board. Ensure the required scope 'boards:read' is available. Ideal for when you need information about documents within board workflows.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
board_identifier | string | Required | Unique identifier of the board to retrieve a specific document item from. |
document_item_id | string | Required | Unique identifier (ID) of the document item to retrieve from the board. |
Requirements
Output
json— Response from the API endpoint 'get-document-item'.MiroApi.RetrieveEdiscoveryCases
Retrieve eDiscovery cases for your organization. Use this tool to obtain a list of eDiscovery cases available within your organization. This is specifically for Enterprise plan users with the Enterprise Guard add-on. Ensure you have the Company Admin and eDiscovery Admin roles.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_id | string | Required | The ID of the organization to retrieve the eDiscovery cases for. |
maximum_items | integer | Optional | Specifies the maximum number of eDiscovery cases to retrieve in the result list. |
pagination_cursor | string | Optional | Indicator for result position in pagination. Leave empty for first page; use previous request's cursor for subsequent pages. |
Requirements
Output
json— Response from the API endpoint 'get-all-cases'.MiroApi.RetrieveItemsByTag
Retrieve items from a board by specifying a tag. Use this tool to get all items from a Miro board that are associated with a specific tag. It helps in organizing and obtaining items based on tag categorization within the board.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
board_id | string | Required | Unique identifier of the board from which to retrieve items by tag. |
tag_identifier | string | Required | Unique identifier (ID) for the tag to retrieve items associated with it. |
max_items_to_retrieve | string | Optional | Specifies the maximum number of items to retrieve with the specified tag from a board. Use an integer. |
pagination_offset | string | Optional | Specifies the number of items to skip before starting to collect the result set. Use to navigate paginated results. |
Requirements
Output
json— Response from the API endpoint 'get-items-by-tag'.MiroApi.RetrieveLegalHoldInfo
Retrieve legal hold information for a specific case. This tool retrieves details of a legal hold within a case for an organization. It's designed for organizations with the Enterprise Guard add-on, and accessible to users with Company Admin and eDiscovery Admin roles.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
case_identifier | string | Required | The unique ID of the case for which you want to retrieve the legal hold information. |
legal_hold_identifier | string | Required | The unique identifier for the legal hold you want to retrieve information about. |
organization_id | string | Required | The unique ID of the organization to retrieve the legal hold information. |
Requirements
Output
json— Response from the API endpoint 'get-legal-hold'.MiroApi.RetrieveLegalHolds
Retrieve all legal holds for an organization's case. This tool retrieves the list of all legal holds within a specified case for an organization. It is intended for Enterprise plan users with the Enterprise Guard add-on, requiring Company Admin and eDiscovery Admin roles.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
case_id | string | Required | The ID of the case for which you want to retrieve the list of legal holds. Ensure it is a valid string identifying the case. |
organization_id | string | Required | The ID of the organization to retrieve the list of legal holds for a specific case. Required for identifying the organization. |
maximum_items_in_result | integer | Optional | Specify the maximum number of items to return in the result list. |
pagination_cursor | string | Optional | An indicator of the result page position. Leave empty for the first page, or use the previous request's cursor value for subsequent pages. |
Requirements
Output
json— Response from the API endpoint 'get-all-legal-holds'.MiroApi.RetrieveMiroExportResults
Retrieve results of a Miro board export job. This tool retrieves the results of an export job for a Miro board, available to Enterprise plan users. It provides detailed information, including an S3 link to the exported files. Ensure you have Company Admin rights and eDiscovery enabled to access this data.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
job_identifier | string | Required | Unique identifier for the Miro board export job, required to retrieve export results. |
organization_unique_identifier | string | Required | The unique identifier for the organization. Required to retrieve export job results. |
Requirements
Output
json— Response from the API endpoint 'enterprise-board-export-job-results'.MiroApi.RetrieveShapeInformation
Retrieve information for a specific shape item on a board. Use this tool to get detailed information about a specific shape item on a Miro board. It requires the 'boards:read' scope and is subject to level 1 rate limiting.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
board_identifier | string | Required | Unique identifier for the board to retrieve a specific shape item from. |
shape_item_id | string | Required | Unique identifier (ID) of the shape item to retrieve from the board. |
Requirements
Output
json— Response from the API endpoint 'get-shape-item-flowchart'.MiroApi.RetrieveTeamMemberById
Retrieve team member details by ID for enterprise users. This tool fetches details about a specific team member within an organization using their ID. It is available only to Miro Enterprise plan users who are Company Admins, and requires the 'organizations:teams:read' scope.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_id | string | Required | The unique identifier for the organization. Required to retrieve team member details. |
team_identifier | string | Required | The unique identifier for the team within the organization. |
team_member_id | string | Required | The unique identifier for the team member to be retrieved. |
Requirements
Output
json— Response from the API endpoint 'enterprise-get-team-member'.MiroApi.RetrieveUserBoards
Retrieve a list of boards accessible to the user. Use this tool to get a list of Miro boards accessible to the user with the given access token. Supports filtering by team or project ID, and fetches boards instantly when filtered by these parameters. Ideal for users needing to view boards they have access to, including organizational admin users who need a broader view.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
board_owner_id | string | Optional | Filter boards by the owner's user ID to view boards created by a specific user. |
maximum_number_of_boards | string | Optional | Specifies the maximum number of boards to retrieve. Use a positive integer to limit results. |
project_id_filter | string | Optional | Specify the project ID to filter boards accessible to the user. This retrieves boards linked to the given project instantly. |
results_offset | string | Optional | The number of items to skip before starting to collect the result set. This is used for pagination. |
search_query | string | Optional | A string to search and filter boards by name or content. Useful for narrowing down results. |
sort_boards_by | string | Optional | Specify how to sort the list of boards. Options include 'default', 'last_modified', 'last_opened', 'last_created', and 'alphabetically'. |
team_identifier | string | Optional | The unique identifier for the team to filter boards. This allows retrieval of boards associated with the specified team. |
Requirements
Output
json— Response from the API endpoint 'get-boards'.MiroApi.ReviewLegalHoldBoards
Review Miro boards under legal hold for legal proceedings. This tool retrieves all Miro board content items under a specific legal hold for an organization. Use it to ensure relevant data is preserved for legal processes. The legal hold must be in an 'ACTIVE' state and available only to Enterprise plan users with appropriate admin roles.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
case_id | string | Required | The unique identifier for the case associated with the legal hold items you wish to retrieve. |
legal_hold_identifier | string | Required | The unique identifier for the legal hold to retrieve content items under hold. |
organization_id | string | Required | The ID of the organization to retrieve the list of content items under hold. |
maximum_items_in_result | integer | Optional | The maximum number of items to include in the result list. Use to limit response size. |
page_cursor | string | Optional | An indicator for pagination. Leave empty for the first page or use a value from the previous request's cursor field for next pages. |
Requirements
Output
json— Response from the API endpoint 'get-legal-hold-content-items'.MiroApi.RevokeMiroAccessToken
Revoke the current Miro access token. This tool revokes the current access token for Miro, rendering both the access and refresh tokens invalid. It should be called when you need to terminate access to Miro resources. The application remains installed for the user, even after token revocation.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
client_id | string | Required | The client ID associated with the access token for Miro. Required for token revocation. |
client_secret | string | Required | The client secret associated with the access token to be revoked. This is required for validation. |
miro_access_token | string | Required | The Miro access token that needs to be revoked, rendering it and the refresh token unusable. |
Requirements
Output
json— Response from the API endpoint 'revoke-token-v2'.MiroApi.SetBoardClassification
Update the data classification for a Miro board. Use this tool to update the classification of a board within the Miro platform. This is an enterprise-only feature requiring Company Admin rights and the 'boards:write' scope.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
board_identifier | string | Required | The unique identifier of the board to update its classification. |
organization_id | string | Required | The ID of the organization to update the board classification for. Required for enterprise users with Company Admin rights. |
team_id | string | Required | The unique identifier of the team associated with the board to be updated. Required for classification updates. |
data_classification_label_id | string | Optional | The ID of the data classification label to apply to the board. |
Requirements
Output
json— Response from the API endpoint 'enterprise-dataclassification-board-set'.MiroApi.UngroupItemsOnMiroBoard
Ungroup items from a group on Miro board. Use this tool to ungroup items from a specific group on a Miro board. This operation requires 'boards:write' scope and is subject to Level 3 rate limiting.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
group_id | string | Required | Unique identifier (ID) of the group to be ungrouped on the Miro board. |
miro_board_id | string | Required | Unique identifier (ID) of the Miro board to ungroup items from. |
remove_items_after_ungrouping | boolean | Optional | Specify if items should be removed after ungrouping. Default is false. |
Requirements
Output
json— Response from the API endpoint 'unGroup'.MiroApi.UpdateBoardClassification
Update board classification for team boards in Miro. This tool updates the classification for either non-classified or all boards within a specified team in an Enterprise Miro account. It requires the user to have Company Admin privileges and the required scope of 'boards:write'. Ideal for Enterprise plan users needing to organize board classifications efficiently.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_id | string | Required | The unique identifier for the organization. Required for specifying which organization's team boards will be classified. |
team_identifier | string | Required | The unique identifier for the team whose board classification is being updated. This is used to specify which team's boards will be affected by the API call. |
assign_to_not_classified_only | boolean | Optional | If true, assign data classification only to non-classified boards; otherwise, assign to all boards. |
data_classification_label_id | integer | Optional | The ID of the data classification label to assign to a team's boards. |
Requirements
Output
json— Response from the API endpoint 'enterprise-dataclassification-team-boards-bulk'.MiroApi.UpdateBoardGroup
Replace and update an existing group in a board. Use this tool to replace an entire group on a Miro board with a new one. The original group is completely replaced and assigned a new group ID each time. Ensure you have the required scope, 'boards:write', to perform this operation.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
board_unique_id | string | Required | Unique identifier for the board to update the group on. |
group_id | string | Required | Unique identifier (ID) of the group to be updated. This ID is required to replace the group. |
item_ids | array<string> | Optional | Array of unique identifiers (IDs) for the items in the new group. |
Requirements
Output
json— Response from the API endpoint 'updateGroup'.MiroApi.UpdateBoardImage
Update an image item on a Miro board using a URL. Use this tool to update an existing image item on a specific Miro board by providing the image URL. Requires 'boards:write' scope and is subject to Level 2 rate limiting.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
board_identifier | string | Required | Unique identifier (ID) of the board where the image item will be updated. |
image_item_id | string | Required | The unique ID of the image item to update on the board. |
image_height_pixels | number | Optional | Specify the height of the image item in pixels. |
image_title | string | Optional | A short text header to identify the image on the board. |
image_url | string | Optional | The URL of the image to update on the board. |
image_width_in_pixels | number | Optional | The width of the image item on the board, specified in pixels. |
item_rotation_angle | number | Optional | Specify the rotation angle for the image item in degrees. Use positive values for clockwise and negative for counterclockwise rotation. |
parent_frame_id | string | Optional | Unique identifier (ID) of the parent frame for the item. |
x_axis_coordinate | number | Optional | X-axis coordinate for the item's location on the board. The board's center is at x: 0. Default is 0. |
y_axis_coordinate_position | number | Optional | The Y-axis coordinate for placing the item on the board. Default is `0`, with absolute positioning on the board. |
Requirements
Output
json— Response from the API endpoint 'update-image-item-using-url'.MiroApi.UpdateBoardMemberRole
Update the role of a Miro board member. This tool updates the role of a member on a Miro board. It should be called when you need to change a member's role on a specific board. Ensure you have the required 'boards:write' scope and consider rate limiting (Level 2) when using this tool.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
board_member_unique_id | string | Required | Unique identifier of the board member whose role needs updating. |
board_unique_identifier | string | Required | Unique identifier for the board where the member role will be updated. |
board_member_role | string | Optional | The new role to assign to the board member. Options: 'viewer', 'commenter', 'editor', 'coowner', 'owner'. |
Requirements
Output
json— Response from the API endpoint 'update-board-member'.MiroApi.UpdateBoardShape
Update a shape item on a Miro board. Use this tool to update the properties and style of a shape item on a specified Miro board. Necessary when changes to a shape's data or appearance are required. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
board_identifier | string | Optional | Unique identifier of the Miro board where you want to update the shape item. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
shape_item_id | string | Optional | Unique identifier (ID) of the shape item to update on the board. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'update-shape-item'.MiroApi.UpdateBoardText
Update a text item on a Miro board. This tool updates a text item on a specified Miro board using provided data and style properties. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
board_id | string | Optional | Unique ID of the Miro board where the text item is to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
text_item_id | string | Optional | Unique identifier (ID) of the text item to update on the board. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'update-text-item'.MiroApi.UpdateBoardWebhookSubscription
Update the status or URL of a board's webhook subscription. Use this tool to modify the status or the callback URL of an existing webhook subscription for a Miro board. This is useful for maintaining webhook integrations with updated configurations.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
subscription_id | string | Required | The unique identifier of the webhook subscription to be updated. |
webhook_callback_url | string | Optional | The HTTPS URL where Miro sends webhooks when events occur. Must be a valid URL. |
webhook_status | string | Optional | Set the webhook subscription status: `enabled`, `disabled`, or handle `lost_access`. |
Requirements
Output
json— Response from the API endpoint 'update-board-subscription'.MiroApi.UpdateCardOnBoard
Update a card item on a Miro board. This tool updates the properties and style of a specific card item on a Miro board. It should be called when you need to modify details or appearance of an existing card on a board. Requires 'boards:write' scope. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
board_identifier | string | Optional | Unique identifier (ID) of the board on which the card item will be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
card_item_id | string | Optional | Unique identifier (ID) of the card item to update on the board. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'update-card-item'.MiroApi.UpdateConnectorOnBoard
Update a connector on a Miro board. Updates a connector's properties and style on a specified Miro board using provided data. Requires 'boards:write' scope and adheres to Level 2 rate limiting. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
board_identifier | string | Optional | The unique string identifier of the Miro board to update the connector on. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
connector_identifier | string | Optional | Unique ID of the connector to update on the board. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'update-connector'.MiroApi.UpdateDocumentItemOnBoard
Update a document item on a Miro board using its URL. This tool updates a specific document item on a Miro board. It should be called when you need to modify the content or metadata of an item on a Miro board by using its URL. Ensure you have the required 'boards:write' scope and be mindful of Level 2 rate limiting.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
board_id | string | Required | Unique identifier of the Miro board where the document item will be updated. |
item_identifier_to_update | string | Required | Unique identifier of the item to update on the board. |
document_hosting_url | string | Optional | URL where the document is hosted for updating on the Miro board. |
document_title | string | Optional | A short text header to identify the document on the board. |
item_height_pixels | number | Optional | Height of the document item in pixels. |
item_width_pixels | number | Optional | Specify the width of the item in pixels on the board. |
parent_frame_id | string | Optional | Unique identifier (ID) of the parent frame for the item on the board. |
rotation_angle_degrees | number | Optional | Rotation angle of an item, in degrees, relative to the board. Positive values rotate clockwise, negative values rotate counterclockwise. |
x_axis_coordinate_on_board | number | Optional | X-axis coordinate for the item's placement on the board, with default positioning at 0. Center of the board is x: 0. |
y_axis_coordinate | number | Optional | Y-axis coordinate for placing the item on the board. Default is 0, with absolute positioning relative to the board center. |
Requirements
Output
json— Response from the API endpoint 'update-document-item-using-url'.MiroApi.UpdateEmbedItemOnBoard
Update an embed item on a Miro board. Use this tool to update specific embed items on a Miro board. Ensure you have the required 'boards:write' scope before calling this tool. This action involves modifying the properties of an embed on the board and is subject to Level 2 rate limiting.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
board_id | string | Required | Unique identifier (ID) of the board where you want to update the item. |
embed_item_id | string | Required | Unique identifier (ID) of the embed item to update on the board. |
content_resource_url | string | Optional | A valid URL pointing to the content resource to embed in the board. Supports HTTP and HTTPS protocols. |
embed_display_mode | string | Optional | Defines how the content in the embed item is displayed on the board. Use 'inline' for direct display and 'modal' for a modal overlay view. |
item_height_in_pixels | number | Optional | Specify the height of the embed item in pixels. |
item_width_pixels | number | Optional | Specifies the width of the item on the board in pixels. |
parent_frame_id | string | Optional | Unique identifier (ID) of the parent frame for the item being updated on the board. |
preview_image_url | string | Optional | URL of the image used as the preview for the embedded item. |
x_axis_coordinate_on_board | number | Optional | X-axis coordinate for the location of the item on the board. Defaults to `0`, representing the center of the board. |
y_axis_coordinate | number | Optional | Y-axis coordinate of the item's location on the board. Defaults to `0`. Center of board is `y: 0`. |
Requirements
Output
json— Response from the API endpoint 'update-embed-item'.MiroApi.UpdateEnterpriseTeam
Update details of an existing enterprise team. This tool updates the details of an existing team in an organization for Enterprise plan users. It requires you to have the role of a Company Admin and the appropriate scope (organizations:teams:write).
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_id | string | Required | The unique identifier of the organization to which the team belongs. |
team_identifier | string | Required | The unique identifier for the team to be updated. |
new_team_name | string | Optional | Specify the new name for the team. |
Requirements
Output
json— Response from the API endpoint 'enterprise-update-team'.MiroApi.UpdateFlowchartShape
Update a shape item in a Miro flowchart board. Use this tool to update the data and style properties of a shape item on a Miro board flowchart. Ideal for modifying existing shapes with new information. Requires 'boards:write' scope. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
board_identifier | string | Optional | Unique identifier of the board where the shape item will be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
item_id | string | Optional | Unique identifier (ID) of the shape item to update on the board. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'update-shape-item-flowchart'.MiroApi.UpdateItemPositionParent
Update an item's position or parent on a Miro board. Use this tool to update the position or change the parent of an item on a Miro board. This requires the 'boards:write' scope and adheres to level 2 rate limiting.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
board_identifier | string | Required | The unique ID of the board where the item's position or parent will be updated. |
item_id | string | Required | Unique identifier of the item to update on the board. |
item_x_axis_coordinate | number | Optional | X-axis coordinate for the item's location on the board. Default is 0, with positioning relative to the board center. |
parent_frame_id | string | Optional | Unique identifier of the parent frame for the specified item. |
y_axis_coordinate | number | Optional | Y-axis coordinate for the item's location on the board. Defaults to `0` with absolute positioning to the board, not the viewport. |
Requirements
Output
json— Response from the API endpoint 'update-item-position-or-parent'.MiroApi.UpdateMiroAppCard
Update an app card item on a Miro board. Use this tool to update an existing app card on a Miro board based on specified data and style properties. Ensure you have the 'boards:write' scope. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
board_identifier | string | Optional | Unique identifier of the board where the app card will be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
item_identifier_for_update | string | Optional | Unique identifier (ID) of the app card item to update on the Miro board. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'update-app-card-item'.MiroApi.UpdateMiroBoard
Update details of a specific Miro board. Use this tool to modify the settings or details of a particular board in Miro. Requires 'boards:write' scope. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
board_identifier | string | Optional | Unique identifier of the Miro board to update. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'update-board'.MiroApi.UpdateMiroBoardFrame
Update a frame on a Miro board with new properties. This tool updates a specific frame on a Miro board. It should be called when you want to modify a frame's data, style, or geometry. Ensure you have the required 'boards:write' scope. Rate limiting is Level 2. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
board_id | string | Optional | Unique identifier (ID) of the board where the frame needs to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
frame_id | string | Optional | Unique identifier of the frame to update on the board. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'update-frame-item'.MiroApi.UpdateMiroTag
Update a tag on a Miro board. This tool updates a specific tag on a Miro board using the provided board and tag IDs. Note that changes made via the API will not be visible in real time on the board; a page refresh is required to see updates.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
board_identifier | string | Required | Unique identifier (ID) of the board where the tag update should occur. |
tag_unique_identifier | string | Required | Unique identifier for the tag you want to update on a Miro board. |
tag_fill_color | string | Optional | Specify the fill color for the tag. Choices are: red, light_green, cyan, yellow, magenta, green, blue, gray, violet, dark_green, dark_blue, black. |
tag_title | string | Optional | Unique, case-sensitive text of the tag to be updated. |
Requirements
Output
json— Response from the API endpoint 'update-tag'.MiroApi.UpdateProjectInfo
Update project details for an enterprise account. This tool updates project information such as name and description in enterprise accounts on Miro. It requires company admin privileges and is only available for Enterprise plan users.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
new_project_name | string | Required | New name to be assigned to the project. |
organization_id | string | Required | The unique identifier of an organization. |
project_identifier | string | Required | The unique identifier for the project to be updated. |
team_id | string | Required | The unique identifier for a team associated with the project. |
Requirements
Output
json— Response from the API endpoint 'enterprise-update-project'.MiroApi.UpdateProjectMemberRole
Update the role and details of a project member. This tool updates details of a project member, primarily focusing on the role within a project. It is specifically for Enterprise plan users with Company Admin rights. The required scope is 'projects:write'. This tool should be used to manage project membership roles and details efficiently.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
member_id | string | Required | The unique identifier for the project member whose role you want to update. |
organization_id | string | Required | The ID of the organization to which the project member belongs. |
project_id | string | Required | The unique ID of the project to be updated. |
team_id | string | Required | The unique identifier for the team that the project member is associated with. Required for specifying which team the member belongs to. |
project_member_role | string | Optional | The new role for the project member. Choose from 'owner', 'editor', 'viewer', 'commentator', or 'coowner'. |
Requirements
Output
json— Response from the API endpoint 'enterprise-update-project-member'.MiroApi.UpdateProjectSettings
Update settings for an enterprise-level project. This tool updates the settings of a specified project within an organization's team, available only for Enterprise plan users with Company Admin roles.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_id | string | Required | The ID of the organization to which the project belongs. |
project_identifier | string | Required | The unique ID of the project whose settings need updating. |
team_id | string | Required | The unique identifier of the team associated with the project. |
team_access_level | string | Optional | Specifies the access level for the team. Use "private" to restrict access to project members only and "view" to allow team-wide viewing. |
Requirements
Output
json— Response from the API endpoint 'enterprise-update-project-settings'.MiroApi.UpdateStickyNote
Update a sticky note on a Miro board. Use this tool to update a sticky note item on a Miro board by providing the necessary data and style properties. Requires 'boards:write' scope. Suitable for instances where users need to modify sticky note contents or appearances remotely. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
board_id_for_update | string | Optional | Unique identifier of the board where the sticky note update will occur. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
sticky_note_id | string | Optional | Unique identifier (ID) of the sticky note you want to update on the board. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'update-sticky-note-item'.MiroApi.UpdateTeamBoardClassificationSettings
Updates board classification settings for a team's existing board. This tool updates the classification settings of a board within a specific team in an enterprise plan. It requires Company Admin permissions and is applicable only for enterprise users. Use this tool to modify board classification settings as necessary for compliance or organizational policy changes.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_id | string | Required | ID of the organization whose team's board classification settings will be updated. |
team_identifier | string | Required | The unique identifier for the team to update board classification settings for. |
data_classification_default_label_id | integer | Optional | The ID of the default data classification label to set for the team. This should be an integer. |
enable_data_classification | boolean | Optional | Enable data classification for the team. Set to `true` to enable, `false` to disable. |
Requirements
Output
json— Response from the API endpoint 'enterprise-dataclassification-team-settings-set'.MiroApi.UpdateTeamMemberRole
Update a team member's role in an enterprise team. This tool updates the role of a specified team member within an enterprise team. It is intended for use by Company Admins on the Miro Enterprise plan. Ensure you have the required scope 'organizations:teams:write' to utilize this endpoint.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_id | string | Required | The unique identifier for the organization. |
team_identifier | string | Required | The unique identifier for the team whose member's role is to be updated. |
team_member_id | string | Required | The unique identifier of the team member whose role is to be updated. |
team_member_role | string | Optional | Role of the team member. Options: 'member', 'admin', 'team_guest'. Specifies permissions within the team. |
Requirements
Output
json— Response from the API endpoint 'enterprise-update-team-member'.MiroApi.UpdateTeamSettings
Update settings for an existing team in Miro Enterprise. This tool updates the settings of a specified team within an organization using Miro's Enterprise API. It is intended for users with the role of Company Admin under the Enterprise plan. Ensure the required scopes are available for successful operation. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
organization_id | string | Optional | The unique identifier for the organization to which the team belongs. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
team_identifier | string | Optional | The unique identifier of the team to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'enterprise-update-team-settings'.