/miro-items | Type: Application | PCID required: Yes
Tools
miro_items_create_app_card_item
Create app card item Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
board_id | string | Yes | — | Unique identifier (ID) of the board where you want to create the item. |
data | object | No | — | Contains app card item data, such as the title, description, or fields. |
geometry | object | No | — | Contains geometrical information about the item, such as its width or height. |
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. |
style | object | No | — | Contains information about the style of an app card item, such as the fill color. |
miro_items_create_card_item
Create card item Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
board_id | string | Yes | — | Unique identifier (ID) of the board where you want to create the item. |
data | object | No | — | Contains card item data, such as the title, description, due date, or assignee ID. |
geometry | object | No | — | Contains geometrical information about the item, such as its width or height. |
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. |
style | object | No | — | Contains information about the style of a card item, such as the card theme. |
miro_items_create_code_widget_item
Create code widget item Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
board_id | string | Yes | — | Unique identifier (ID) of the board where you want to create the item. |
data | object | No | — | Contains the data properties of a code widget item, such as the code content, programming language, and display settings. |
geometry | object | No | — | Contains geometrical information about the item, such as its width or height. |
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_items_create_doc_format_item
Create doc format item Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
board_id | string | Yes | — | Unique identifier (ID) of the board where you want to create the item. |
data | object | Yes | — | The data value |
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_items_create_document_item_using_file_from_device
Create document item using file from device Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
board_id_PlatformFileUpload | string | Yes | — | Unique identifier (ID) of the board where you want to create the item. |
data | object | No | — | The data value |
resource | string | Yes | — | Select a file to upload. Maximum file size is 6 MB. |
miro_items_create_document_item_using_url
Create document item using URL Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
board_id | string | Yes | — | Unique identifier (ID) of the board where you want to create the item. |
data | object | Yes | — | Contains information about the document URL. |
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_items_create_embed_item
Create embed item Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
board_id | string | Yes | — | Unique identifier (ID) of the board where you want to create the item. |
data | object | Yes | — | Contains information about the embed URL. |
geometry | object | No | — | Contains geometrical information about the item. You can set either the width or height. You cannot set both the width and height at the same time. |
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_items_create_image_item_using_local_file
Create image item using file from device Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
board_id_PlatformFileUpload | string | Yes | — | Unique identifier (ID) of the board where you want to create the item. |
data | object | No | — | The data value |
resource | string | Yes | — | Select a file to upload. Maximum file size is 6 MB. |
miro_items_create_image_item_using_url
Create image item using URL Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
board_id | string | Yes | — | Unique identifier (ID) of the board where you want to create the item. |
data | object | Yes | — | Contains information about the image URL. |
geometry | object | No | — | Contains geometrical information about the item, such as its width or rotation. You can set either the width or height, you cannot set both the width and height at the same time. |
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_items_create_shape_item
Create shape item Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
board_id | string | Yes | — | Unique identifier (ID) of the board where you want to create the item. |
data | object | No | — | Contains shape item data, such as the content or the type of the shape. |
geometry | object | No | — | Contains geometrical information about the item, such as its width or height. |
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. |
style | object | No | — | Contains information about the shape style, such as the border color or opacity. <br> All properties in style object are supported for shape types aren’t listed below. <br> <table> <tr> <th align=“left”>Shape type</th> <th align=“left”>Unsupported properties</th> </tr> <tr> <td>flow_chart_or</td> <td>fontSize, fontFamily, color, textAlign, textAlignVertical</td> </tr> <tr> <td>flow_chart_summing_junction</td> <td>fontSize, fontFamily, color, textAlign, textAlignVertical</td> </tr> <tr> <td>flow_chart_note_curly_left</td> <td>fillColor, fillOpacity</td> </tr> <tr> <td>flow_chart_note_curly_right</td> <td>fillColor, fillOpacity</td> </tr> <tr> <td>flow_chart_note_square</td> <td>fillColor, fillOpacity</td> </tr> </table> |
miro_items_create_sticky_note_item
Create sticky note item Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
board_id | string | Yes | — | Unique identifier (ID) of the board where you want to create the item. |
data | object | No | — | Contains sticky note item data, such as the content or shape of the sticky note. |
geometry | object | No | — | Contains geometrical information about the item. You can set either the width or height. You cannot set both the width and height at the same time. |
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. |
style | object | No | — | Contains information about the style of a sticky note item, such as the fill color or text alignment. |
miro_items_create_text_item
Create text item Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
board_id | string | Yes | — | Unique identifier (ID) of the board where you want to create the item. |
data | object | Yes | — | Contains text item data, such as the title, content, or description. For more information on the JSON properties, see Data. |
geometry | object | No | — | Contains geometrical information about the item, such as its width or rotation. You can only specify the width of the text item as the height is dynamically updated based on the content. |
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. |
style | object | No | — | Contains information about the style of a text item, such as the fill color or font family. |
miro_items_delete_app_card_item
Delete app card item Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
board_id | string | Yes | — | Unique identifier (ID) of the board from which you want to delete an item. |
item_id | string | Yes | — | Unique identifier (ID) of the item that you want to delete. |
miro_items_delete_card_item
Delete card 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_items_delete_code_widget_item
Delete code widget 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_items_delete_doc_format_item
Delete doc format 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_items_delete_document_item
Delete document 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_items_delete_embed_item
Delete embed 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_items_delete_image_item
Delete image 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_items_delete_shape_item
Delete shape 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_items_delete_sticky_note_item
Delete sticky note 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_items_delete_text_item
Delete text 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_items_get_app_card_item
Get app card item 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_items_get_card_item
Get card item 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_items_get_code_widget_item
Get code widget item 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_items_get_code_widget_items
Get code widget items 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. |
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 code widget items. |
miro_items_get_doc_format_item
Get doc format item 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. |
textContentType | string | No | — | Controls the contentType of the returned doc’s content. |
miro_items_get_document_item
Get document item 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_items_get_embed_item
Get embed item 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_items_get_image_item
Get image item 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_items_get_shape_item
Get shape item 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_items_get_sticky_note_item
Get sticky note item 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_items_get_text_item
Get text item 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_items_move_code_widget_item
Move code widget item Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
board_id | string | Yes | — | Unique identifier (ID) of the board where you want to move the item. |
item_id | string | Yes | — | Unique identifier (ID) of the item that you want to move. |
x | number | No | — | X-axis coordinate of the location of the item on the board. By default, all items have absolute positioning to the board, not the current viewport. Default: 0. The center point of the board has x: 0 and y: 0 coordinates. |
y | number | No | — | Y-axis coordinate of the location of the item on the board. By default, all items have absolute positioning to the board, not the current viewport. Default: 0. The center point of the board has x: 0 and y: 0 coordinates. |
miro_items_update_app_card_item
Update app card item 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. |
data | object | No | — | Contains app card item data, such as the title, description, or fields. |
geometry | object | No | — | Contains geometrical information about the item, such as its width or height. |
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. |
style | object | No | — | Contains information about the style of an app card item, such as the fill color. |
miro_items_update_card_item
Update card item 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. |
data | object | No | — | Contains card item data, such as the title, description, due date, or assignee ID. |
geometry | object | No | — | Contains geometrical information about the item, such as its width or height. |
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. |
style | object | No | — | Contains information about the style of a card item, such as the card theme. |
miro_items_update_code_widget_item
Update code widget item 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. |
data | object | No | — | Contains the data properties of a code widget item, such as the code content, programming language, and display settings. |
geometry | object | No | — | Contains geometrical information about the item, such as its width or height. |
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_items_update_document_item_using_file_from_device
Update document item using file from device Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
board_id_PlatformFileUpload | 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. |
data | object | No | — | The data value |
resource | string | Yes | — | Select a file to upload. Maximum file size is 6 MB. |
miro_items_update_document_item_using_url
Update document item using URL 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. |
data | object | No | — | Contains information about the document URL. |
geometry | object | No | — | Contains geometrical information about the item, such as its width or rotation. You can set either the width or height, you cannot set both the width and height at the same time. |
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_items_update_embed_item
Update embed item 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. |
data | object | No | — | Contains information about the embed URL. |
geometry | object | No | — | Contains geometrical information about the item. You can set either the width or height. You cannot set both the width and height at the same time. |
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_items_update_image_item_using_file_from_device
Update image item using file from device Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
board_id_PlatformFileUpload | 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. |
data | object | No | — | The data value |
resource | string | Yes | — | Select a file to upload. Maximum file size is 6 MB. |
miro_items_update_image_item_using_url
Update image item using URL 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. |
data | object | No | — | Contains information about the image URL. |
geometry | object | No | — | Contains geometrical information about the item, such as its width or rotation. You can set either the width or height, you cannot set both the width and height at the same time. |
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_items_update_shape_item
Update shape item 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. |
data | object | No | — | Contains shape item data, such as the content or the type of the shape. |
geometry | object | No | — | Contains geometrical information about the item, such as its width or height. |
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. |
style | object | No | — | Contains information about the shape style, such as the border color or opacity. <br> All properties in style object are supported for shape types aren’t listed below. <br> <table> <tr> <th align=“left”>Shape type</th> <th align=“left”>Unsupported properties</th> </tr> <tr> <td>flow_chart_or</td> <td>fontSize, fontFamily, color, textAlign, textAlignVertical</td> </tr> <tr> <td>flow_chart_summing_junction</td> <td>fontSize, fontFamily, color, textAlign, textAlignVertical</td> </tr> <tr> <td>flow_chart_note_curly_left</td> <td>fillColor, fillOpacity</td> </tr> <tr> <td>flow_chart_note_curly_right</td> <td>fillColor, fillOpacity</td> </tr> <tr> <td>flow_chart_note_square</td> <td>fillColor, fillOpacity</td> </tr> </table> |
miro_items_update_sticky_note_item
Update sticky note item 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. |
data | object | No | — | Contains sticky note item data, such as the content or shape of the sticky note. |
geometry | object | No | — | Contains geometrical information about the item. You can set either the width or height. You cannot set both the width and height at the same time. |
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. |
style | object | No | — | Contains information about the style of a sticky note item, such as the fill color or text alignment. |
miro_items_update_text_item
Update text item 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. |
data | object | No | — | Contains text item data, such as the title, content, or description. For more information on the JSON properties, see Data. |
geometry | object | No | — | Contains geometrical information about the item, such as its width or rotation. You can only specify the width of the text item as the height is dynamically updated based on the content. |
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. |
style | object | No | — | Contains information about the style of a text item, such as the fill color or font family. |

