Data

Structure of the data object and its properties.

The following tables list the data properties of each supported item type.

App card item data

Property name	Property type	Description
`title`	String	A short text header for the app card. Besides plain text, `title` also supports the following HTML tags: - `<p>` - `<a>` - `<br>` Unsupported HTML tags are automatically stripped.
`description`	String	A short text description to provide context and details about the app card. Besides plain text, `description` also supports the following HTML tags: - `<p>` - `<a>` - `<strong>` - `<b>` - `<em>` - `<i>` - `<u>` - `<ol>` - `<ul>` - `<li>` - `<br>` Unsupported HTML tags are automatically stripped.
`owned`	Boolean	A read-only Boolean value that controls read and write access to the app card. - `true`: the app requesting access can read and write to the app card properties. - `false`: the app requesting access can only read the app card properties. Only the app that created the app card has read and write access to it. Other apps can only view the app card properties.
`fields`	Object array	Each object in the array represents a custom preview field that you can define for the app card. The preview fields are displayed on the bottom half of the app card in the compact view. For each preview field, you can define: - The data value of the custom field. For example, you can use value to communicate status or completion information; or a due date; or a plain text string. - The color of the text. - A background color for the preview field. - An image for the icon. The shape of the icon: either round, or square. - A short text for the tooltip displayed when clicking or hovering over the preview field.

App card `data.fields`

Property name	Property type	Description
`fillColor`	String	Hex value representing the color that fills the background area of the preview field, when it's displayed on the app card. Default: transparent (no fill color)
`iconShape`	String	Defines the shape of the icon on the preview field. Possible values: - `round` - `square`
`iconUrl`	String	A valid URL pointing to an image available online. The transport protocol must be HTTPS. Possible image file formats: - JPG, JPEG - PNG - SVG
`textColor`	String	Hex value representing the color of the text string assigned to value. Default: `#1a1a1a` (black)
`tooltip`	String	A short text displayed in a tooltip when clicking or hovering over the preview field.
`value`	String	The actual data value of the custom field. It can be any type of information that you want to convey. For example, you can use value to communicate status or completion information; or a due date; or a plain text string.

"data": {
        "title": "Card #540"
        "description": "A small task to facilitate taking over the world"
        "fields": [
            {
                "fillColor": "#FF5733",
                "iconShape": "square",
                "iconUrl": "https://cdn-icons-png.flaticon.com/512/5039/5039294.png",
                "textColor": "#000000",
                "tooltip": "World domination, attempt #147",
                "value": "New side project"
            }
        ],
        "owned": true,
    },

Card item data

Property name	Property type	Description
`title`	String	A short text header for the card. Besides plain text, `title` also supports the following HTML tags: - `<p>` - `<a>` - `<br>` Unsupported HTML tags are automatically stripped.
`description`	String	A short text description to provide context and details about the card. Besides plain text, `description` also supports the following HTML tags: - `<p>` - `<a>` - `<strong>` - `<b>` - `<em>` - `<i>` - `<u>` - `<ol>` - `<ul>` - `<li>` - `<br>` Unsupported HTML tags are automatically stripped.
`dueDate`	String	The date when the task or activity described in the card is due to be completed. In the GUI, users can select the due date from a calendar. Format: UTC, adheres to ISO 8601, includes a trailing Z offset.
`assigneeId`	String	Unique user identifier. In the GUI, the user ID is mapped to the name of the user who is assigned as the owner of the task or activity described in the card. The identifier is numeric, and it is automatically assigned to a user when they first sign up.

"data": {
        "title": "sample card item",
        "description": "sample card description",
        "dueDate": "2023-10-12T22:00:55Z",
        "assigneeId": "3074457353169356249"
    }

Document item data

Property name	Property type	Description
`title`	String	A short text header to identify the document.

"data": {
    "title": "sample document item title"
  },

Embed item data

Property name	Property type	Description
`contentType`	String	The data type of the embedded content, as returned by the content provider. For example: video, image, rich.
`description`	String	A text extract providing a short description of the embedded content, as returned by the content provider.
`html`	String	The HTML with the iFrame containing the embedded content, as generated by the Embedly service.
`providerName`	String	The name of the content provider. For example: YouTube, Vimeo, Imgur.
`providerUrl`	String	The base URL associated with the content provider. For example: `https://www.youtube.com/
`thumbnailUrl`	String	URL of the image to be used as the thumbnail image for the embedded item
`title`	String	The title of the embedded content, as returned by the content provider.
`url`	String	A valid URL pointing to the content resource that you want to embed. This is the URL that you pass when you send a REST API request to embed external content in a board. Possible transport protocols: - HTTP - HTTPS
`view`	String	Defines the embed item view. Possible values: `inline` or `overlay`. Default: `inline`.

 "data": {
    "contentType": "video",
    "description": "So this is how to organize your life with Miro (a virtual whiteboard) for collaboration, brainstorming, and project management. Students, designers, agile en...",
    "html": "<iframe class=\"embedly-embed\" src=\"//cdn.embedly.com/widgets/media.html?src=https%3A%2F%2Fwww.youtube.com%2Fembed%2FHlVSNEiFCBk%3Ffeature%3Doembed&display_name=YouTube&url=https%3A%2F%2Fwww.youtube.com%2Fwatch%3Fv%3DHlVSNEiFCBk&image=https%3A%2F%2Fi.ytimg.com%2Fvi%2FHlVSNEiFCBk%2Fhqdefault.jpg&key=9902b9af489942c6ac17c2ce50fdfe1e&type=text%2Fhtml&schema=youtube\" width=\"854\" height=\"480\" scrolling=\"no\" title=\"YouTube embed\" frameborder=\"0\" allow=\"autoplay; fullscreen\" allowfullscreen=\"true\"></iframe>",
    "providerName": "YouTube",
    "providerUrl": "https://www.youtube.com/",
    "title": "HOW TO ORGANIZE YOUR LIFE WITH MIRO! ✏️ Virtual Whiteboard Tour",
    "url": "https://www.youtube.com/watch?v=HlVSNEiFCBk",
    "view": "inline"
  }

Frame item data

Property name	Property type	Description
`title`	String	A short text header for the frame.

"data": {
    "title": "Logo frame"
}

Image item data

Property name	Property type	Description
`title`	String	A short text header to identify the image.

"data": {
        "title": "sample image"
    }

Preview item data

Property name	Property type	Description
`description`	String	A text extract providing a short description of the content, as returned by the content provider.
`title`	String	The title of the preview content, as returned by the content provider.
`url`	String	A valid URL pointing to a web page. Possible transport protocols: - HTTP - HTTPS

"data": {
    "description": "With enterprise-ready security and advanced administration controls, deploy Miro company-wide with ease. A dedicated Customer Success and Account Manager will partner with you every step of the way to ensure your team's success and train you on best practices we've picked up from other enterprise customers.",
    "title": "Online Whiteboard & Visual Collaboration Platform | Miro",
    "url": "https://miro.com"
  }

Shape item data

Property name	Property type	Description
`content`	String	The text you want to display on the shape. Besides plain text, `content` supports also the following HTML tags: - `<p>` - `<a>` - `<strong>` - `<b>` - `<em>` - `<i>` - `<u>` - `<s>` - `<span>` - `<br>` Unsupported HTML tags are automatically stripped.
`shapeType`	String	Defines the geometric shape of the item when it is rendered on the board. Possible values: - `rectangle` - `round_rectangle` - `circle` - `triangle` - `rhombus` - `parallelogram` - `trapezoid` - `pentagon` - `hexagon` - `octagon` - `wedge_round_rectangle_callout` - `star` - `flow_chart_predefined_process` - `cloud` - `cross` - `can` - `right_arrow` - `left_arrow` - `left_right_arrow` - `left_brace` - `right_brace` Default: `rectangle`

"data": {
        "content": "shape content",
        "shapeType": "rectangle"
    }

Sticky note item data

Property name	Property type	Description
`content`	String	The text you want to display on the shape. Besides plain text, `content` supports also the following HTML tags: - `<p>` - `<a>` - `<strong>` - `<b>` - `<em>` - `<i>` - `<u>` - `<s>` - `<br>` Unsupported HTML tags are automatically stripped.

"data": {
        "content": "sample sticky note item"
    }

Text item data

Property name	Property type	Description
`content`	String	The text you want to display on the text item. Besides plain text, `content` supports also the following HTML tags: - `<p>` - `<a>` - `<strong>` - `<b>` - `<em>` - `<i>` - `<u>` - `<s>` - `<span>` - `<ol>` - `<ul>` - `<li>` - `<br>` Unsupported HTML tags are automatically stripped.

"data": {
        "content": "<p>This is a text item</p>"
    }

App card item data

App card data.fields

Card item data

Document item data

Embed item data

Frame item data

Image item data

Preview item data

Shape item data

Sticky note item data

Text item data

App card `data.fields`