Skip to main content
Server path: /miro-items | Type: Application | PCID required: Yes

Tools

ToolDescription
miro_items_create_app_card_itemCreate app card item
miro_items_create_card_itemCreate card item
miro_items_create_code_widget_itemCreate code widget item
miro_items_create_doc_format_itemCreate doc format item
miro_items_create_document_item_using_file_from_deviceCreate document item using file from device
miro_items_create_document_item_using_urlCreate document item using URL
miro_items_create_embed_itemCreate embed item
miro_items_create_image_item_using_local_fileCreate image item using file from device
miro_items_create_image_item_using_urlCreate image item using URL
miro_items_create_shape_itemCreate shape item
miro_items_create_sticky_note_itemCreate sticky note item
miro_items_create_text_itemCreate text item
miro_items_delete_app_card_itemDelete app card item
miro_items_delete_card_itemDelete card item
miro_items_delete_code_widget_itemDelete code widget item
miro_items_delete_doc_format_itemDelete doc format item
miro_items_delete_document_itemDelete document item
miro_items_delete_embed_itemDelete embed item
miro_items_delete_image_itemDelete image item
miro_items_delete_shape_itemDelete shape item
miro_items_delete_sticky_note_itemDelete sticky note item
miro_items_delete_text_itemDelete text item
miro_items_get_app_card_itemGet app card item
miro_items_get_card_itemGet card item
miro_items_get_code_widget_itemGet code widget item
miro_items_get_code_widget_itemsGet code widget items
miro_items_get_doc_format_itemGet doc format item
miro_items_get_document_itemGet document item
miro_items_get_embed_itemGet embed item
miro_items_get_image_itemGet image item
miro_items_get_shape_itemGet shape item
miro_items_get_sticky_note_itemGet sticky note item
miro_items_get_text_itemGet text item
miro_items_move_code_widget_itemMove code widget item
miro_items_update_app_card_itemUpdate app card item
miro_items_update_card_itemUpdate card item
miro_items_update_code_widget_itemUpdate code widget item
miro_items_update_document_item_using_file_from_deviceUpdate document item using file from device
miro_items_update_document_item_using_urlUpdate document item using URL
miro_items_update_embed_itemUpdate embed item
miro_items_update_image_item_using_file_from_deviceUpdate image item using file from device
miro_items_update_image_item_using_urlUpdate image item using URL
miro_items_update_shape_itemUpdate shape item
miro_items_update_sticky_note_itemUpdate sticky note item
miro_items_update_text_itemUpdate text item

miro_items_create_app_card_item

Create app card item Parameters:
ParameterTypeRequiredDefaultDescription
board_idstringYesUnique identifier (ID) of the board where you want to create the item.
dataobjectNoContains app card item data, such as the title, description, or fields.
geometryobjectNoContains geometrical information about the item, such as its width or height.
parentobjectNoContains information about the parent frame for the item.
positionobjectNoContains 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.
styleobjectNoContains information about the style of an app card item, such as the fill color.

miro_items_create_card_item

Create card item Parameters:
ParameterTypeRequiredDefaultDescription
board_idstringYesUnique identifier (ID) of the board where you want to create the item.
dataobjectNoContains card item data, such as the title, description, due date, or assignee ID.
geometryobjectNoContains geometrical information about the item, such as its width or height.
parentobjectNoContains information about the parent frame for the item.
positionobjectNoContains 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.
styleobjectNoContains information about the style of a card item, such as the card theme.

miro_items_create_code_widget_item

Create code widget item Parameters:
ParameterTypeRequiredDefaultDescription
board_idstringYesUnique identifier (ID) of the board where you want to create the item.
dataobjectNoContains the data properties of a code widget item, such as the code content, programming language, and display settings.
geometryobjectNoContains geometrical information about the item, such as its width or height.
parentobjectNoContains information about the parent frame for the item.
positionobjectNoContains 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:
ParameterTypeRequiredDefaultDescription
board_idstringYesUnique identifier (ID) of the board where you want to create the item.
dataobjectYesThe data value
parentobjectNoContains information about the parent frame for the item.
positionobjectNoContains 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:
ParameterTypeRequiredDefaultDescription
board_id_PlatformFileUploadstringYesUnique identifier (ID) of the board where you want to create the item.
dataobjectNoThe data value
resourcestringYesSelect a file to upload. Maximum file size is 6 MB.

miro_items_create_document_item_using_url

Create document item using URL Parameters:
ParameterTypeRequiredDefaultDescription
board_idstringYesUnique identifier (ID) of the board where you want to create the item.
dataobjectYesContains information about the document URL.
parentobjectNoContains information about the parent frame for the item.
positionobjectNoContains 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:
ParameterTypeRequiredDefaultDescription
board_idstringYesUnique identifier (ID) of the board where you want to create the item.
dataobjectYesContains information about the embed URL.
geometryobjectNoContains 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.
parentobjectNoContains information about the parent frame for the item.
positionobjectNoContains 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:
ParameterTypeRequiredDefaultDescription
board_id_PlatformFileUploadstringYesUnique identifier (ID) of the board where you want to create the item.
dataobjectNoThe data value
resourcestringYesSelect a file to upload. Maximum file size is 6 MB.

miro_items_create_image_item_using_url

Create image item using URL Parameters:
ParameterTypeRequiredDefaultDescription
board_idstringYesUnique identifier (ID) of the board where you want to create the item.
dataobjectYesContains information about the image URL.
geometryobjectNoContains 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.
parentobjectNoContains information about the parent frame for the item.
positionobjectNoContains 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:
ParameterTypeRequiredDefaultDescription
board_idstringYesUnique identifier (ID) of the board where you want to create the item.
dataobjectNoContains shape item data, such as the content or the type of the shape.
geometryobjectNoContains geometrical information about the item, such as its width or height.
parentobjectNoContains information about the parent frame for the item.
positionobjectNoContains 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.
styleobjectNoContains 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:
ParameterTypeRequiredDefaultDescription
board_idstringYesUnique identifier (ID) of the board where you want to create the item.
dataobjectNoContains sticky note item data, such as the content or shape of the sticky note.
geometryobjectNoContains 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.
parentobjectNoContains information about the parent frame for the item.
positionobjectNoContains 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.
styleobjectNoContains 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:
ParameterTypeRequiredDefaultDescription
board_idstringYesUnique identifier (ID) of the board where you want to create the item.
dataobjectYesContains text item data, such as the title, content, or description. For more information on the JSON properties, see Data.
geometryobjectNoContains 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.
parentobjectNoContains information about the parent frame for the item.
positionobjectNoContains 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.
styleobjectNoContains 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:
ParameterTypeRequiredDefaultDescription
board_idstringYesUnique identifier (ID) of the board from which you want to delete an item.
item_idstringYesUnique identifier (ID) of the item that you want to delete.

miro_items_delete_card_item

Delete card item Parameters:
ParameterTypeRequiredDefaultDescription
board_idstringYesUnique identifier (ID) of the board from which you want to delete the item.
item_idstringYesUnique identifier (ID) of the item that you want to delete.

miro_items_delete_code_widget_item

Delete code widget item Parameters:
ParameterTypeRequiredDefaultDescription
board_idstringYesUnique identifier (ID) of the board from which you want to delete the item.
item_idstringYesUnique identifier (ID) of the item that you want to delete.

miro_items_delete_doc_format_item

Delete doc format item Parameters:
ParameterTypeRequiredDefaultDescription
board_idstringYesUnique identifier (ID) of the board from which you want to delete the item.
item_idstringYesUnique identifier (ID) of the item that you want to delete.

miro_items_delete_document_item

Delete document item Parameters:
ParameterTypeRequiredDefaultDescription
board_idstringYesUnique identifier (ID) of the board from which you want to delete the item.
item_idstringYesUnique identifier (ID) of the item that you want to delete.

miro_items_delete_embed_item

Delete embed item Parameters:
ParameterTypeRequiredDefaultDescription
board_idstringYesUnique identifier (ID) of the board from which you want to delete the item.
item_idstringYesUnique identifier (ID) of the item that you want to delete.

miro_items_delete_image_item

Delete image item Parameters:
ParameterTypeRequiredDefaultDescription
board_idstringYesUnique identifier (ID) of the board from which you want to delete the item.
item_idstringYesUnique identifier (ID) of the item that you want to delete.

miro_items_delete_shape_item

Delete shape item Parameters:
ParameterTypeRequiredDefaultDescription
board_idstringYesUnique identifier (ID) of the board from which you want to delete the item.
item_idstringYesUnique identifier (ID) of the item that you want to delete.

miro_items_delete_sticky_note_item

Delete sticky note item Parameters:
ParameterTypeRequiredDefaultDescription
board_idstringYesUnique identifier (ID) of the board from which you want to delete the item.
item_idstringYesUnique identifier (ID) of the item that you want to delete.

miro_items_delete_text_item

Delete text item Parameters:
ParameterTypeRequiredDefaultDescription
board_idstringYesUnique identifier (ID) of the board from which you want to delete the item.
item_idstringYesUnique identifier (ID) of the item that you want to delete.

miro_items_get_app_card_item

Get app card item Parameters:
ParameterTypeRequiredDefaultDescription
board_idstringYesUnique identifier (ID) of the board from which you want to retrieve a specific item.
item_idstringYesUnique identifier (ID) of the item that you want to retrieve.

miro_items_get_card_item

Get card item Parameters:
ParameterTypeRequiredDefaultDescription
board_idstringYesUnique identifier (ID) of the board from which you want to retrieve a specific item.
item_idstringYesUnique identifier (ID) of the item that you want to retrieve.

miro_items_get_code_widget_item

Get code widget item Parameters:
ParameterTypeRequiredDefaultDescription
board_idstringYesUnique identifier (ID) of the board from which you want to retrieve a specific item.
item_idstringYesUnique identifier (ID) of the item that you want to retrieve.

miro_items_get_code_widget_items

Get code widget items Parameters:
ParameterTypeRequiredDefaultDescription
limitstringNoThe 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.
cursorstringNoA 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_idstringYesUnique 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:
ParameterTypeRequiredDefaultDescription
board_idstringYesUnique identifier (ID) of the board from which you want to retrieve a specific item.
item_idstringYesUnique identifier (ID) of the item that you want to retrieve.
textContentTypestringNoControls the contentType of the returned doc’s content.

miro_items_get_document_item

Get document item Parameters:
ParameterTypeRequiredDefaultDescription
board_idstringYesUnique identifier (ID) of the board from which you want to retrieve a specific item.
item_idstringYesUnique identifier (ID) of the item that you want to retrieve.

miro_items_get_embed_item

Get embed item Parameters:
ParameterTypeRequiredDefaultDescription
board_idstringYesUnique identifier (ID) of the board from which you want to retrieve a specific item.
item_idstringYesUnique identifier (ID) of the item that you want to retrieve.

miro_items_get_image_item

Get image item Parameters:
ParameterTypeRequiredDefaultDescription
board_idstringYesUnique identifier (ID) of the board from which you want to retrieve a specific item.
item_idstringYesUnique identifier (ID) of the item that you want to retrieve.

miro_items_get_shape_item

Get shape item Parameters:
ParameterTypeRequiredDefaultDescription
board_idstringYesUnique identifier (ID) of the board from which you want to retrieve a specific item.
item_idstringYesUnique identifier (ID) of the item that you want to retrieve.

miro_items_get_sticky_note_item

Get sticky note item Parameters:
ParameterTypeRequiredDefaultDescription
board_idstringYesUnique identifier (ID) of the board from which you want to retrieve a specific item.
item_idstringYesUnique identifier (ID) of the item that you want to retrieve.

miro_items_get_text_item

Get text item Parameters:
ParameterTypeRequiredDefaultDescription
board_idstringYesUnique identifier (ID) of the board from which you want to retrieve a specific item.
item_idstringYesUnique identifier (ID) of the item that you want to retrieve.

miro_items_move_code_widget_item

Move code widget item Parameters:
ParameterTypeRequiredDefaultDescription
board_idstringYesUnique identifier (ID) of the board where you want to move the item.
item_idstringYesUnique identifier (ID) of the item that you want to move.
xnumberNoX-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.
ynumberNoY-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:
ParameterTypeRequiredDefaultDescription
board_idstringYesUnique identifier (ID) of the board where you want to update the item.
item_idstringYesUnique identifier (ID) of the item that you want to update.
dataobjectNoContains app card item data, such as the title, description, or fields.
geometryobjectNoContains geometrical information about the item, such as its width or height.
parentobjectNoContains information about the parent frame for the item.
positionobjectNoContains 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.
styleobjectNoContains information about the style of an app card item, such as the fill color.

miro_items_update_card_item

Update card item Parameters:
ParameterTypeRequiredDefaultDescription
board_idstringYesUnique identifier (ID) of the board where you want to update the item.
item_idstringYesUnique identifier (ID) of the item that you want to update.
dataobjectNoContains card item data, such as the title, description, due date, or assignee ID.
geometryobjectNoContains geometrical information about the item, such as its width or height.
parentobjectNoContains information about the parent frame for the item.
positionobjectNoContains 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.
styleobjectNoContains information about the style of a card item, such as the card theme.

miro_items_update_code_widget_item

Update code widget item Parameters:
ParameterTypeRequiredDefaultDescription
board_idstringYesUnique identifier (ID) of the board where you want to update the item.
item_idstringYesUnique identifier (ID) of the item that you want to update.
dataobjectNoContains the data properties of a code widget item, such as the code content, programming language, and display settings.
geometryobjectNoContains geometrical information about the item, such as its width or height.
parentobjectNoContains information about the parent frame for the item.
positionobjectNoContains 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:
ParameterTypeRequiredDefaultDescription
board_id_PlatformFileUploadstringYesUnique identifier (ID) of the board where you want to update the item.
item_idstringYesUnique identifier (ID) of the item that you want to update.
dataobjectNoThe data value
resourcestringYesSelect a file to upload. Maximum file size is 6 MB.

miro_items_update_document_item_using_url

Update document item using URL Parameters:
ParameterTypeRequiredDefaultDescription
board_idstringYesUnique identifier (ID) of the board where you want to update the item.
item_idstringYesUnique identifier (ID) of the item that you want to update.
dataobjectNoContains information about the document URL.
geometryobjectNoContains 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.
parentobjectNoContains information about the parent frame for the item.
positionobjectNoContains 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:
ParameterTypeRequiredDefaultDescription
board_idstringYesUnique identifier (ID) of the board where you want to update the item.
item_idstringYesUnique identifier (ID) of the item that you want to update.
dataobjectNoContains information about the embed URL.
geometryobjectNoContains 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.
parentobjectNoContains information about the parent frame for the item.
positionobjectNoContains 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:
ParameterTypeRequiredDefaultDescription
board_id_PlatformFileUploadstringYesUnique identifier (ID) of the board where you want to update the item.
item_idstringYesUnique identifier (ID) of the item that you want to update.
dataobjectNoThe data value
resourcestringYesSelect a file to upload. Maximum file size is 6 MB.

miro_items_update_image_item_using_url

Update image item using URL Parameters:
ParameterTypeRequiredDefaultDescription
board_idstringYesUnique identifier (ID) of the board where you want to update the item.
item_idstringYesUnique identifier (ID) of the item that you want to update.
dataobjectNoContains information about the image URL.
geometryobjectNoContains 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.
parentobjectNoContains information about the parent frame for the item.
positionobjectNoContains 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:
ParameterTypeRequiredDefaultDescription
board_idstringYesUnique identifier (ID) of the board where you want to update the item.
item_idstringYesUnique identifier (ID) of the item that you want to update.
dataobjectNoContains shape item data, such as the content or the type of the shape.
geometryobjectNoContains geometrical information about the item, such as its width or height.
parentobjectNoContains information about the parent frame for the item.
positionobjectNoContains 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.
styleobjectNoContains 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:
ParameterTypeRequiredDefaultDescription
board_idstringYesUnique identifier (ID) of the board where you want to update the item.
item_idstringYesUnique identifier (ID) of the item that you want to update.
dataobjectNoContains sticky note item data, such as the content or shape of the sticky note.
geometryobjectNoContains 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.
parentobjectNoContains information about the parent frame for the item.
positionobjectNoContains 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.
styleobjectNoContains 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:
ParameterTypeRequiredDefaultDescription
board_idstringYesUnique identifier (ID) of the board where you want to update the item.
item_idstringYesUnique identifier (ID) of the item that you want to update.
dataobjectNoContains text item data, such as the title, content, or description. For more information on the JSON properties, see Data.
geometryobjectNoContains 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.
parentobjectNoContains information about the parent frame for the item.
positionobjectNoContains 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.
styleobjectNoContains information about the style of a text item, such as the fill color or font family.