Enhance Miro to fit the way you work

Automate, extend, and customize Miro to fit your teamwork.
Create Apps that combine Rest API, Webhooks and Web-Plugins.
Bring your collaboration to the next level.

Get Started

This documentation section explains how to embed a live collaborative Miro board into your website through an iframe. You can embed a Miro board into any web application, product, or website free of cost.

Approaches and APIs to embed a Miro board

The following sections describe different ways to embed a Miro board.

1. Live Embed via direct board link

If you know the board ID, you can embed an existing board by creating a direct embed link.

Use the following URL:

https://miro.com/app/live-embed/{board_id}

The board is shared with its current sharing settings.

2. Using Boards Picker from JavaScript

This approach works as follows:

  • Implement the Boards Picker component that allows the user to log on to Miro, pick a board, and choose the sharing settings with which the user wants to embed the board.
  • In response, the Boards Picker component provides you with the board_id and access_link for this board, which you can use to embed the board that was picked.

See an example flow in Coda + Miro integration.

:warning+: The Boards Picker component requires enablement on Miro side :warning+:
Read more on how to set up Boards Picker.

3. Editable temporary boards for unregistered users

With this approach, the user of your integration can embed a temporary Miro board without being a registered Miro user.

See an example flow in Whereby + Miro integration.

Features:

1) access-link — allows users to get a special access-link for the selected board and embed it on the website via iframe.
2) allowCreateAnonymousBoards you can allow not registered in Miro users to create a new board and embed it on the website via iframe.

:warning+: this flow requires enablement on Miro side :warning+:
Read more how to set up editable boards for anonymous users

Updated 2 months ago


Overview


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.