Introduction

Welcome to the public release of the Miro Developer Platform 2.0.

📘

Public release of the Miro Developer Platform 2.0

We're pleased to announce that the Miro Developer Platform 2.0 is now available as a public release.
The Miro Developer Platform enables building apps and integrations that enhance and extend Miro board functionality.

Happy development!

Web SDK

The Web SDK is a JavaScript library that you can use to build apps that enrich user experience. Apps interact with the board's graphical user interface to create, update, and delete board items such as images, cards, or sticky notes.

What can I do with the Web SDK?

The Web SDK supports CRUD operations on the following board items:

Board item/tagCreateReadUpdateDelete
App card
Card
Embed
Emoji
Frame
Image
Kanban
Mindmap
Preview
Shape
Sticky note
Stroke
SVG
Table
Tag
Text
Children of parent item
USM
Webscreen
Wireframe

Web SDK resources

REST API

The REST API is a set of HTTP methods that you can use to build integrations that don't rely on interactions in the Miro interface. Integrations connect a Miro board to a third-party product or service to exchange data programmatically, and to enable flows that require communicating with a server backend or a database. For example, data synchronization between a Miro board and a third-party product such as Jira or Airtable.

What can I do with the REST API?

The REST API supports the following CRUD operations on boards, board members, and supported board items:

Board itemCreateReadUpdateDelete
App card
Board
Board member
Card
Document
Embed
Emoji
Frame
Image
Kanban
Mindmap
Organization (Enterprise plan only)
Organization member (Enterprise plan only)
Preview
Shape
Sticky note
Stroke
SVG
Table
Tag
Team (Enterprise plan only)
Team member (Enterprise plan only)
Team settings (Enterprise plan only)
Text
USM
Webscreen
Wireframe

REST API resources