Jump to Content
Guides
Web SDK 2.0
REST API 2.0
Live Embed
SCIM API
Changelog
Roadmap
Community
Guides
API Reference
Changelog
v1.0
v2.0-dx-improvements
v2.0
Guides
Web SDK 2.0
REST API 2.0
Live Embed
SCIM API
Changelog
Roadmap
Community
Build your app
Build your app
Moon (Dark Mode)
Sun (Light Mode)
v1.0
Search
Discard
Submit Suggested Edits
These docs are for v1.0. Click to read the latest docs for v2.0.
Apps in Miro
Welcome to the Miro Developer Platform
Getting started
Build your first Hello, World app
Configure and install your app in Miro
Try out your app in Miro
Create your app in Miro
Bootstrap the Hello, World app
Create a Developer team in Miro
Differences between plans
REST API
Quick Start
API Reference
Web-Plugins
Web-plugins overview
Web-plugins features
Extension points
How to use extension points
Web-plugin Authorization
Share your app
FAQs
Embed Miro Whiteboard
Overview
Embed a board via direct link
boardsPicker Component
Editable boards for not registered users
FAQs
Getting Published in Miro Marketplace
Submit to the Miro Marketplace
Getting your app design approved
Security Guidelines
Design guidelines
Overview
Examples and inspiration
Examples from Marketplace
Ideas for inspiration
Import data to board
Web-plugins examples
Add and remove users
SDK Reference
Account and User
interface-iuserinfo
interface-icurrentusercommands
interface-iaccountcommands
interface-authorizationoptions
interface-ipictureinfo
interface-iaccountinfo
Board Manipulation
interface-iboardcommentscommands
interface-iboardcommands
interface-iboardutils
interface-iboardinfo
interface-iviewportoptions
interface-iboardselectioncommands
interface-iboardviewportcommands
interface-iboardinfocommands
interface-iboardgroupscommands
interface-igroup
Extension Points
interface-iboarduicommands
interface-ipluginconfigextensionpoints
interface-exportmenubutton
interface-draggableitemscontaineroptions
interface-toolbarbutton
interface-bottombarbutton
Styling
enumeration-borderstyle
enumeration-fontfamily
enumeration-linestyle
enumeration-linetype
enumeration-textalignvertical
interface-ienums
enumeration-stickertype
enumeration-shapetype
enumeration-linearrowheadstyle
enumeration-textalign
Widgets Manipulation
interface-iwidgetnamespaces
interface-iwebscreenshotwidget
interface-icomment
interface-iboardwidgetscommands
interface-iboardtagscommands
interface-iframewidget
interface-itag
interface-icardwidget
interface-iwidgetshortdata
interface-iemojiwidget
interface-iembedwidget
interface-icurvewidget
interface-itextwidget
interface-idocumentwidget
interface-ipreviewwidget
interface-iimagewidget
interface-imockupwidget
interface-istickerwidget
interface-iwidget
interface-ilinewidget
interface-ishapewidget
interface-event
interface-ibounds
interface-ioffset
interface-ipluginconfig
interface-ipluginsettingsconfig
interface-ipoint
interface-irect
interface-iwidgetmenuitem
namespace-sdk
The `window.miro` Object
Resources
Changelog
Support and community
Policies
Developer terms of use
App development policy
Deprecation policy
Suggest