Jump to Content
Miro Developer PlatformGuidesWeb SDK 2.0REST API 2.0Live EmbedSCIM APIChangelogRoadmapCommunity
HomeGuidesAPI ReferenceChangelog
GuidesWeb SDK 2.0REST API 2.0Live EmbedSCIM APIChangelogRoadmapCommunityBuild your appMiro Developer Platform
Build your app

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
  • 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
    • Apps and engagement wrap-up
  • In-depth training modules
    • 1: create your 1st Miro app locally
    • 2: build a fullstack Miro app

Miro Platform Concepts

  • Introduction
  • The Developer team
    • Create a Developer team
    • Change the Developer team name
    • Delete the Developer team
  • Miro Web SDK and REST API usage
  • 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
  • Frame
  • Image
  • Preview
  • Shape
  • Sticky note
  • Text
  • Tag
  • App manifest

Miro Web SDK

  • Video: try the Web SDK in less than 1 minute
  • Quickstart
  • Build your first Hello, World app
    • Manually create an app in Your apps
  • Miro Web SDK introduction
    • Miro Web SDK and board items
    • App panels and modals
  • Miro Web SDK 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
    • Deploy a Miro app
    • 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
    • SVG app icon optimization guidelines
    • Upload images and SVGs as base64-encoded strings
  • Miro Web SDK reference
    • Interact with boards and items
    • Board
    • BoardUI
    • Viewport
    • Notifications
    • AppCard
    • Card
    • Connector
    • Embed
    • Frame
    • Image
    • Preview
    • Shape
    • StickyNote
    • Text
    • Tag
    • Unsupported
    • Rate limiting
    • Error handling

Miro API clients

  • 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 REST API

  • Video: try the REST API in less than 3 minutes
  • Quickstart
  • REST API tutorials
    • Get started with OAuth 2.0 and Miro
    • Enable REST API authentication from Miro's Web SDK authorization
    • 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
  • REST API reference

Miro SCIM API

  • Miro SCIM API introduction
  • User lifecycle management with SCIM
  • Enable SCIM
  • Users
  • Groups
  • Discovery features
  • Rate limits
  • Errors

Miro Live Embed

  • Introduction
  • Live Embed 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
  • Live Embed authentication
  • Live Embed support for oEmbed
  • Live Embed reference

Miro Marketplace

  • App design guidelines
  • App security guidelines
  • App development policy
  • Submit your app for review
  • Marketplace listing guidelines

Community

  • Overview

Resources

  • Changelog
  • Roadmap
  • Miro App Examples
  • Mirotone
  • Support
  • Migrate from v1 to v2
    • Web SDK Comparison Guide
    • Web SDK Reference Guide
    • REST API Comparison Guide
    • REST API Reference Guide

Policies

  • Developer terms of use
  • App development policy
  • Deprecation policy

Support

Suggest Edits
  • Join our Developer community on Discord to exchange ideas and to chat with other Miro developers.

  • Stuck somewhere? Encountered any blockers or errors? Need assistance? We're here to help you! Ask your question on our developer community forum.

Updated 7 months ago