Jump to Content
MCP
Documentation
Resources
Marketplace
Community
Documentation
API Reference
Changelog
v2.0
MCP
Documentation
Resources
Marketplace
Community
Build your app
Documentation
Build your app
main
Documentation
Getting started
Getting started
Search
Platform Essentials
Introduction
Web SDK vs REST API
Getting started
Developer team
Create a Developer team
Change the Developer team name
Delete the Developer team
Migrating a developer app
App manifest
Concepts
Boards
Board items
Children inside parent items
App card
App card use cases
Edit, update, and keep app cards synced
Backend flow for app cards
Enable REST API authentication from Miro's Web SDK authorization
Enable 2-way sync between app cards and GitHub cards
Card
Connector
Embed
Events
Frame
Image
Mind map (Experimental)
Preview
Shape
Sticky note
Storage
Text
Tag
Migrate from v1 to v2
Web SDK comparison guide
Web SDK reference guide
REST API comparison guide
REST API reference guide
MCP
Miro's MCP Server
Connecting to Miro's MCP Server
Miro MCP Server Tools & Prompts
Connecting Miro's MCP Server to MCP-compatible clients
Tutorial: How to Generate Diagrams from Code w/ Miro MCP & VSCode + GitHub Copilot
Tutorial: Build a Node.js app from a Miro Board with Miro MCP + Cursor
Tutorial: How to Build a Landing Page from a Miro Board w/ Lovable + Miro MCP
Web SDK
Introduction
Miro Web SDK and board items
App panels and modals
Guided onboarding
Onboarding essentials
1) Create your first board item with the Web SDK
2) Update an item's properties with `sync()`
3) Run your first app in Miro
4) Interact with your app in Miro
5) Join the conversation
6) Install a Marketplace app
7) Add Mirotone to an existing app
Onboarding wrap-up
Challenge: Where's Miro?
Submit and share your app
1) Share an app outside of a developer team
2) Understand app submission requirements
3) Publish a Miro app
4) Share your ideas with us
Submit and share wrap-up
In-depth training modules
1) Create your 1st Miro app locally
2) Build a full-stack Miro app
Getting started
Quickstart
Video: try the Web SDK in less than 1 minute
Build your first Hello World app
Build a Web SDK app
Build a REST API app
Build a full-stack (Next.js) app
Enable running apps as instant apps
How-Tos & tutorials
Use the browser developer tools with the Miro Web SDK
Update and sync item properties
Add icon click to your app
Add an icon to your app
Add drag and drop to your app
Add permission scopes to your app
Add search and filter to your app
Build a calendar app in Miro
Convert sticky notes to shapes
Create mind map from CSV
Add custom actions to your app
Deploy a Miro app
Log in to a third-party service using OAuth
Enable 2-way sync between app cards and GitHub cards
Enable REST API authentication from Miro's Web SDK authorization
Integrate a digital asset manager in Miro
Convert frame coordinates to board coordinates
SVG app icon optimization guidelines
Upload images and SVGs as base64-encoded strings
Connect the Miro Web SDK to a backend (Firebase)
Video: Deploy a Next.js App on AWS Amplify
Video: Integrate OpenAI + Miro
Build collaborative app experiences
Display banner/modal on a Miro board using DynamoDB
Display banner/modal on a Miro board using AWS S3
Reference
Interact with boards and items
Rate limiting
Error handling
Board
Card
Board UI
Viewport
Notifications
App card
Experimental
Realtime Events
Tag
Custom Action Management
Shape
Frame
Image
Sticky Note
Shape experimental
Embed
Connector
Unsupported
Mindmap Node
Preview
Text
Storage collection
Storage
Collaboration
Session
Attention
Group
History
Tools
REST API
Introduction
Getting started
Quickstart
Video: try the REST API in less than 3 minutes
Build your first Hello World REST API app
How-To's & tutorials
Get started with OAuth 2.0 and Miro
Enable REST API authentication from Miro's Web SDK authorization
Access Enterprise APIs
Create sticky notes and tags
Convert code to diagram with Miro PlantUML
Get user info and email
Create an image from a data URL source
Work with connectors
Securely manage boards and teams at scale
Enable 2-way sync between app cards and GitHub cards
Set up a test endpoint for webhooks with Pipedream
Troubleshoot OAuth2.0
Video: OAuth Essentials for Frontenders
Miro Node.js client
Miro Node.js client Readme
Miro Node.js client quickstart for task automation
Miro Node.js client quickstart with OAuth and Express
Implement data storage
Reference documentation
Miro Python client
Reference
Marketplace
Miro Marketplace
Get ready for Marketplace
App design guidelines
App security guidelines
App development policy
App listing guidelines
Build and deploy your app
Your Marketplace profile
Publish your app
Monetization
Monetization with Miro + Stripe
Monetization with Miro + Salable (Subscription Management)
Provide pricing details for your app
Developer benefits
App Metrics
SCIM API
Introduction
User lifecycle management
Getting started
Concepts
Rate limits
Reference
Users
Groups
Discovery features
Live Embed
Introduction
Getting started
Authentication
oEmbed support
How-Tos & tutorials
Live Embed with a direct link
Live Embed view-only mode
Live Embed with BoardsPicker for registered users
Live Embed with BoardsPicker for unregistered users
Reference
Resources
Resources overview
Changelog
Roadmap
Mirotone
Miro app examples
Miro Postman сollection
Policies
Developer terms of use
App development policy
Lifecycle policy
Deprecation policy
Powered by
Getting started
This page has a new home. Click here to go to the new page.
Updated about 14 hours ago
