Jump to Content
Miro Developer PlatformGuidesWeb SDK 2.0REST API 2.0SCIM APILive EmbedChangelogRoadmap
HomeGuidesAPI ReferenceChangelog
GuidesWeb SDK 2.0REST API 2.0SCIM APILive EmbedChangelogRoadmapMy AppsMiro Developer Platform
My Apps

Miro Platform Concepts

  • Introduction
    • About the public release
  • Boards
  • Board items
    • App card
    • Card
    • Embed
    • Frame
    • Image
    • Preview
    • Shape
    • Sticky note
    • Text
    • Tag
  • Item geometry
  • Children inside parent items
  • Miro Web SDK and REST API usage

Miro Web SDK

  • Video: try the Web SDK in less than 1 minute
  • Quickstart
  • Build your first Hello, World app
  • Miro Web SDK introduction
    • 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 REST API authentication from Miro's Web SDK authorization
    • Enable 2-way sync between app cards and GitHub cards
    • Integrate a digital asset manager in Miro
  • Miro Web SDK reference
    • Interact with boards and items
    • Board
    • BoardUI
    • Viewport
    • AppCard
    • Card
    • Embed
    • Frame
    • Image
    • Preview
    • Shape
    • StickyNote
    • Text
    • Tag
    • Unsupported
    • Rate limiting
    • Error handling

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
    • Enable 2-way sync between app cards and GitHub cards
    • Work with connectors
  • 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
  • Quickstart
  • Authentication
  • Live Embed tutorials
    • Live Embed with a direct link
    • Live Embed with BoardsPicker for registered users
    • Live Embed with BoardsPicker for unregistered users
  • Live Embed reference

Miro Marketplace

  • Submit your app
  • Design guidelines
  • Security guidelines
  • App development policy

Resources

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

Policies

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

Video: try the Web SDK in less than 1 minute

Get started in less than 1 minute: watch the video walkthrough and use the Miro Web SDK in the developer console to get acquainted with its feature set.

Suggest Edits

See also

  • Check Miro App Examples on GitHub
  • Try the Web SDK in less than 1 minute
  • Use the developer tools with the Miro Web SDK
  • Build your first Hello, World app

Updated 2 months ago


Did this page help you?
  • Table of Contents
    • See also