/miro-boards | Type: Application | PCID required: Yes
Tools
miro_boards_attach_tag_to_item
Attach tag to item Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
board_id_PlatformTags | string | Yes | — | Unique identifier (ID) of the board with the item that you want to add a tag to. |
item_id | string | Yes | — | Unique identifier (ID) of the item to which you want to add a tag. |
tag_id | string | Yes | — | Unique identifier (ID) of the tag you want to add to the item. |
miro_boards_copy_board
Copy board Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
copy_from | string | Yes | — | Unique identifier (ID) of the board that you want to copy. |
description | string | No | — | Description of the board. |
name | string | No | — | Name for the board. |
policy | object | No | — | Defines the permissions policies and sharing policies for the board. |
teamId | string | No | — | Unique identifier (ID) of the team where the board must be placed. |
miro_boards_create_board
Create board Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
description | string | No | — | Description of the board. |
name | string | No | — | Name for the board. |
policy | object | No | — | Defines the permissions policies and sharing policies for the board. |
projectId | string | No | — | Unique identifier (ID) of the project to which the board must be added. Note: Projects have been renamed to Spaces. Use this parameter to update the space. For Starter and Edu plans, Team Admins looking to move boards between Spaces/Projects of the same team would need to be direct Board Editors on the boards to move. |
teamId | string | No | — | Unique identifier (ID) of the team where the board must be placed. Note: On Enterprise plan, boards can be moved via API by Board Owners, Co-Owners, and Content Admins. This behavior differs from the Miro UI, where only Board Owners can move boards. This difference is intentional and works as designed. On non-Enterprise plans, only Board Owners can move boards between teams—both via the API and the Miro UI. |
miro_boards_create_connector
Create connector Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
board_id | string | Yes | — | Unique identifier (ID) of the board for which you want to create the connector. |
captions | object[] | No | — | Blocks of text you want to display on the connector. |
endItem | object | Yes | — | The end point of the connector. endItem.id must be different from startItem.id |
shape | string | No | — | The path type of the connector line, defines curvature. Default: curved. |
startItem | object | Yes | — | The end point of the connector. endItem.id must be different from startItem.id |
style | object | No | — | Contains information about the style of a connector, such as the color or caption font size |
miro_boards_create_frame_item
Create frame Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
board_id | string | Yes | — | Unique identifier (ID) of the board where you want to create a frame. |
data | object | Yes | — | Contains frame item data, such as the title, frame type, or frame format. |
geometry | object | No | — | Contains geometrical information about the item, such as its width or height. |
position | object | No | — | Contains information about the item’s position on the board, such as its x coordinate, y coordinate, and the origin of the x and y coordinates. |
style | object | No | — | Contains information about the style of a frame item, such as the fill color. |
miro_boards_create_group
Create group Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
board_id | string | Yes | — | Unique identifier (ID) of the board |
description | string | No | — | User group description |
id | string | Yes | — | User group ID |
name | string | Yes | — | User group name |
type | string | Yes | — | Object type |
miro_boards_create_items
Create items in bulk Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
board_id | string | Yes | — | Unique identifier (ID) of the board where you want to create the item. |
body | object[] | Yes | — | Request body |
miro_boards_create_items_in_bulk_using_file_from_device
Create items in bulk using file from device Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
board_id | string | Yes | — | Unique identifier (ID) of the board where you want to create the item. |
data | string | Yes | — | JSON file containing bulk data, where each object represents an item to be created. For details, see JSON file example. |
resources | string[] | Yes | — | Array of items to create (PDFs, images, etc.). Maximum of 20 items. |
miro_boards_create_tag
Create tag Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
board_id | string | Yes | — | Unique identifier (ID) of the board where you want to create the tag. |
fillColor | string | No | — | Fill color for the tag. |
title | string | Yes | — | Text of the tag. Case-sensitive. Must be unique. |
miro_boards_delete_board
Delete board Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
board_id | string | Yes | — | Unique identifier (ID) of the board that you want to delete. |
miro_boards_delete_connector
Delete connector Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
board_id | string | Yes | — | Unique identifier (ID) of the board from which you want to delete the connector. |
connector_id | string | Yes | — | Unique identifier (ID) of the connector that you want to delete. |
miro_boards_delete_frame_item
Delete frame Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
board_id | string | Yes | — | Unique identifier (ID) of the board from which you want to delete the frame. |
item_id | string | Yes | — | Unique identifier (ID) of the frame that you want to delete. |
miro_boards_delete_group
Deletes the group Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
board_id | string | Yes | — | Unique identifier (ID) of the board. |
group_id | string | Yes | — | Unique identifier (ID) of the group. |
delete_items | boolean | Yes | — | Indicates whether the items should be removed. Set to true to delete items in the group. |
miro_boards_delete_item
Delete item Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
board_id | string | Yes | — | Unique identifier (ID) of the board from which you want to delete the item. |
item_id | string | Yes | — | Unique identifier (ID) of the item that you want to delete. |
miro_boards_delete_tag
Delete tag Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
board_id | string | Yes | — | Unique identifier (ID) of the board where you want to delete a specific tag. |
tag_id | string | Yes | — | Unique identifier (ID) of the tag that you want to delete. |
miro_boards_get_all_groups
Get all groups on a board Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
board_id | string | Yes | — | Unique identifier (ID) of the board. |
limit | integer | No | — | The maximum number of items to return at one time, default is 10, maximum is 50. |
cursor | string | No | — | Pagination cursor from a previous response |
miro_boards_get_board_members
Get all board members Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
limit | string | No | — | The maximum number of board members to retrieve. Default: 20. |
offset | string | No | — | The (zero-based) offset of the first item in the collection to return. Default: 0. |
board_id | string | Yes | — | Unique identifier (ID) of the board to which the board member belongs. |
miro_boards_get_boards
Get boards Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
team_id | string | No | — | The team_id for which you want to retrieve the list of boards. If this parameter is sent in the request, the query and owner parameters are ignored. |
project_id | string | No | — | The project_id for which you want to retrieve the list of boards.<br/>Note: Projects have been renamed to Spaces. Use this as the unique identifier (ID) of the space. If this parameter is included in the request, the query and owner parameters are ignored. |
query | string | No | — | Retrieves a list of boards that contain the query string provided in the board name or board description. For example, if you want to retrieve a list of boards that have the word beta in the board name or description, add beta as the query parameter value. You can use the query parameter with the owner parameter to narrow down the board search results. |
owner | string | No | — | Retrieves a list of boards that belong to a specific owner ID. You must pass the owner ID (for example, 3074457353169356300), not the owner name. You can use the ‘owner’ parameter with the query parameter to narrow down the board search results. Note that if you pass the team_id in the same request, the owner parameter is ignored. |
limit | string | No | — | The maximum number of boards to retrieve. Default: 20 |
offset | string | No | — | The (zero-based) offset of the first item in the collection to return. Default: 0. |
sort | string | No | — | Sort order in which you want to view the result set. The parameter is applicable only when you search for boards by team or project. * default - If team_id is present, last_created. Otherwise, last_opened. * last_modified - sort by the date and time when the board was last modified. * last_opened - sort by the date and time when the board was last opened. * last_created - sort by the date and time when the board was created. * alphabetically - sort by the board name (alphabetically). |
miro_boards_get_connector
Get specific connector Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
board_id | string | Yes | — | Unique identifier (ID) of the board from which you want to retrieve a specific connector. |
connector_id | string | Yes | — | Unique identifier (ID) of the connector that you want to retrieve. |
miro_boards_get_connectors
Get connectors Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
limit | string | No | — | The maximum number of results to return per call. If the number of connectors in the response is greater than the limit specified, the response returns the cursor parameter with a value. |
cursor | string | No | — | A cursor-paginated method returns a portion of the total set of results based on the limit specified and a cursor that points to the next portion of the results. To retrieve the next portion of the collection, set the cursor parameter equal to the cursor value you received in the response of the previous request. |
board_id | string | Yes | — | Unique identifier (ID) of the board from which you want to retrieve a list of connectors. |
miro_boards_get_frame_item
Get frame Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
board_id | string | Yes | — | Unique identifier (ID) of the board that contains the frame that you want to retrieve |
item_id | string | Yes | — | Unique identifier (ID) of the frame that you want to retrieve. |
miro_boards_get_group_by_id
Get a group by its ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
board_id | string | Yes | — | Unique identifier (ID) of the board. |
group_id | string | Yes | — | Unique identifier (ID) of the group. |
miro_boards_get_items
Get items on board Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
limit | string | No | — | The maximum number of results to return per call. If the number of items in the response is greater than the limit specified, the response returns the cursor parameter with a value. |
type | string | No | — | If you want to get a list of items of a specific type, specify an item type. For example, if you want to retrieve the list of card items, set type to cards. A document is meant for uploaded documents like PDFs while doc_format is a Miro structured document similar to a Google Doc. Possible values: app_card, card, data_table_format, document, embed, frame, image, shape, sticky_note, text, doc_format |
cursor | string | No | — | A cursor-paginated method returns a portion of the total set of results based on the limit specified and a cursor that points to the next portion of the results. To retrieve the next portion of the collection, set the cursor parameter equal to the cursor value you received in the response of the previous request. |
board_id | string | Yes | — | Unique identifier (ID) of the board for which you want to retrieve the list of available items. |
miro_boards_get_items_by_group_id
Get items of a group by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
board_id | string | Yes | — | Unique identifier (ID) of the board. |
limit | integer | No | — | The maximum number of items to return at one time, default is 10, maximum is 50. |
cursor | string | No | — | Pagination cursor from a previous response |
group_item_id | string | Yes | — | The ID of the group item to retrieve. |
miro_boards_get_items_by_tag
Get items by tag Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
limit | string | No | — | The maximum number of items that can be returned for a single request. Default: 20. |
offset | string | No | — | The displacement of the first item in the collection to return. Default: 0. |
board_id_PlatformTags | string | Yes | — | Unique identifier (ID) of the board where you want to retrieve a specific tag. |
tag_id | string | Yes | — | Unique identifier (ID) of the tag that you want to retrieve. |
miro_boards_get_items_within_frame
Get items within frame Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
board_id_PlatformContainers | string | Yes | — | Unique identifier (ID) of the board that contains the frame for which you want to retrieve the list of available items. |
parent_item_id | string | Yes | — | ID of the frame for which you want to retrieve the list of available items. |
limit | string | No | — | The maximum number of results to return per call. If the number of items in the response is greater than the limit specified, the response returns the cursor parameter with a value. |
type | string | No | — | If you want to get a list of items of a specific type, specify an item type. For example, if you want to retrieve the list of card items, set type to cards. Possible values: app_card, card, document, embed, frame, image, shape, sticky_note, text |
cursor | string | No | — | A cursor-paginated method returns a portion of the total set of results based on the limit specified and a cursor that points to the next portion of the results. To retrieve the next portion of the collection, set the cursor parameter equal to the cursor value you received in the response of the previous request. |
miro_boards_get_specific_board
Get specific board Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
board_id | string | Yes | — | Unique identifier (ID) of the board that you want to retrieve. |
miro_boards_get_specific_board_member
Get specific board member Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
board_id | string | Yes | — | Unique identifier (ID) of the board to which the board member belongs. |
board_member_id | string | Yes | — | Unique identifier (ID) of the board member whose role you want to retrieve. |
miro_boards_get_specific_item
Get specific item on board Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
board_id | string | Yes | — | Unique identifier (ID) of the board from which you want to retrieve a specific item. |
item_id | string | Yes | — | Unique identifier (ID) of the item that you want to retrieve. |
miro_boards_get_tag
Get tag Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
board_id | string | Yes | — | Unique identifier (ID) of the board where you want to retrieve a specific tag. |
tag_id | string | Yes | — | Unique identifier (ID) of the tag that you want to retrieve. |
miro_boards_get_tags_from_board
Get tags from board Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
limit | string | No | — | The maximum number of items that can be returned for a single request. Default: 20. |
offset | string | No | — | The displacement of the first item in the collection to return. Default: 0. |
board_id | string | Yes | — | Unique identifier (ID) of the board whose tags you want to retrieve. |
miro_boards_get_tags_from_item
Get tags from item Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
board_id | string | Yes | — | Unique identifier (ID) of the board with the item whose tags you want to retrieve. |
item_id | string | Yes | — | Unique identifier (ID) of the item whose tags you want to retrieve. |
miro_boards_remove_board_member
Remove board member Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
board_id | string | Yes | — | Unique identifier (ID) of the board from which you want to delete an item. |
board_member_id | string | Yes | — | Unique identifier (ID) of the board member whose role you want to delete. |
miro_boards_remove_tag_from_item
Remove tag from item Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
board_id_PlatformTags | string | Yes | — | Unique identifier (ID) of the board with the item that you want to remove a tag from. |
item_id | string | Yes | — | Unique identifier (ID) of the item that you want to remove the tag from. |
tag_id | string | Yes | — | Unique identifier (ID) of the tag that you want to remove from the item. |
miro_boards_share_board
Share board Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
board_id | string | Yes | — | Unique identifier (ID) of the board to which the board member belongs. |
emails | string[] | Yes | — | Email IDs of the users you want to invite to the board. You can invite up to 20 members per call. |
message | string | No | — | The message that will be sent in the invitation email. |
role | string | No | — | Role of the board member. Inviting users with the role owner has the same effect as the role coowner. |
miro_boards_un_group
Ungroup items Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
board_id | string | Yes | — | Unique identifier (ID) of the board. |
group_id | string | Yes | — | Unique identifier (ID) of the group. |
delete_items | boolean | No | — | Indicates whether the items should be removed. By default, false. |
miro_boards_update_board
Update board Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
board_id | string | Yes | — | Unique identifier (ID) of the board that you want to update. |
description | string | No | — | Description of the board. |
name | string | No | — | Name for the board. |
policy | object | No | — | Defines the permissions policies and sharing policies for the board. |
projectId | string | No | — | Unique identifier (ID) of the project to which the board must be added. Note: Projects have been renamed to Spaces. Use this parameter to update the space. For Starter and Edu plans, Team Admins looking to move boards between Spaces/Projects of the same team would need to be direct Board Editors on the boards to move. |
teamId | string | No | — | Unique identifier (ID) of the team where the board must be placed. Note: On Enterprise plan, boards can be moved via API by Board Owners, Co-Owners, and Content Admins. This behavior differs from the Miro UI, where only Board Owners can move boards. This difference is intentional and works as designed. On non-Enterprise plans, only Board Owners can move boards between teams—both via the API and the Miro UI. |
miro_boards_update_board_member
Update board member Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
board_id | string | Yes | — | Unique identifier (ID) of the board for which you want to update the role of the board member. |
board_member_id | string | Yes | — | Unique identifier (ID) of the board member whose role you want to update. |
role | string | No | — | Role of the board member. |
miro_boards_update_connector
Update connector Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
board_id | string | Yes | — | Unique identifier (ID) of the board for which you want to update the connector. |
connector_id | string | Yes | — | Unique identifier (ID) of the connector that you want to update. |
captions | object[] | No | — | Blocks of text you want to display on the connector. |
endItem | object | No | — | The ending point of the connector. If startItem is also provided, endItem.id must be different from startItem.id |
shape | string | No | — | The path type of the connector line, defines curvature. Default: curved. |
startItem | object | No | — | The ending point of the connector. If startItem is also provided, endItem.id must be different from startItem.id |
style | object | No | — | Contains information about the style of a connector, such as the color or caption font size |
miro_boards_update_frame_item
Update frame Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
board_id | string | Yes | — | Unique identifier (ID) of the board where you want to update the frame. |
item_id | string | Yes | — | Unique identifier (ID) of the frame that you want to update. |
data | object | No | — | Contains frame item data, such as the title, frame type, or frame format. |
geometry | object | No | — | Contains geometrical information about the item, such as its width or height. |
position | object | No | — | Contains information about the item’s position on the board, such as its x coordinate, y coordinate, and the origin of the x and y coordinates. |
style | object | No | — | Contains information about the style of a frame item, such as the fill color. |
miro_boards_update_group
Updates a group with new items Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
board_id | string | Yes | — | Unique identifier (ID) of the board. |
group_id | string | Yes | — | Unique identifier (ID) of the group. |
description | string | No | — | User group description |
id | string | Yes | — | User group ID |
name | string | Yes | — | User group name |
type | string | Yes | — | Object type |
miro_boards_update_item_position_or_parent
Update item position or parent Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
board_id | string | Yes | — | Unique identifier (ID) of the board where you want to update the item. |
item_id | string | Yes | — | Unique identifier (ID) of the item that you want to update. |
parent | object | No | — | Contains information about the parent frame for the item. |
position | object | No | — | Contains information about the item’s position on the board, such as its x coordinate, y coordinate, and the origin of the x and y coordinates. |
miro_boards_update_tag
Update tag Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
board_id | string | Yes | — | Unique identifier (ID) of the board where you want to update a specific tag. |
tag_id | string | Yes | — | Unique identifier (ID) of the tag that you want to update. |
fillColor | string | No | — | Fill color for the tag. |
title | string | No | — | Text of the tag. Case-sensitive. Must be unique. |

