Introduction

Our APIs are based on a RESTful approach (see REST). It features predictable and resource-oriented URLs and uses HTTP response codes to indicate API errors. Our REST APIs comprise of HTTP methods that you can use to build integrations that don't rely on interactions in the Miro interface.

Why you should use our REST APIs:

• Connect a Miro board to a third-party product.
• Enable flows that require communicating with a server backend or a database.
• Enable a service to exchange data programmatically using languages other than Javascript or Typescript.

Enterprise plan

Certain APIs are only available on the Enterprise plan. You can access Enterprise APIs only if you have the Company Admin role. The goal of providing these additional capabilities for Enterprise plan users is to enable a consistent and secure user experience while creating your custom solutions. Additionally, to install applications that use the Enterprise APIs, you must have a team with an Enterprise plan. For example, the Teams API provides the capability to manage teams in your organization. As Miro Teams at scale are only available within the Enterprise plan, the scope of the Teams API is also limited to the Enterprise plan only.

📘

Temporary access

You can request a temporary access to enterprise APIs by filling out this request form.

For more information on various plans and the feature matrix, see the Miro pricing plan page.

Access Enterprise APIs

Learn how to access Miro's Enterprise APIs.

What can I do with the REST API?

The REST API supports the following CRUD operations on boards, board members, and supported board items: