These docs are for v1.0. Click to read the latest docs for v2.0.

Quick Start

Create your app

Step-by-step of how to create a board and widget via REST API right from the documentation

  1. Create Dev-team.
  2. Create an app.
  3. Configure scopes.
  4. Get accessToken.
  5. Create a board by clicking the Try it button in the documentation.
  6. Create a card-widget on the board by clicking the Try it button.

Check out our Demo App

We created NodeJS example to show how Miro Rest API works. This example includes:

  • OAuth implementation
  • REST API calls
  • Serving static files for web-plugin

About API-related objects

  • A user can participate in one or more teams, or even zero teams, if the user was deleted from all teams. For simplicity, you can assume that every user has at least one team.
  • A team can belong to an organization (Company), and it may not. Organizations are not represented in the API yet.
  • Every board belongs to exactly one team.
  • Registered and invited users are connected with teams and boards via user-connection objects.