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.

What can I do with the REST API?

📘
These APIs are free to use. Only a Miro account and developer team is needed. See our quickstart guide and video on how to get started using our REST APIs.

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

Board item	Create	Read	Update	Delete
App card	✅	✅	✅	✅
Board	✅	✅	✅	✅
Board member	✅	✅	✅	✅
Card	✅	✅	✅	✅
Connector	✅	✅	✅	✅
Comment	❌	❌	❌	❌
Document	✅	✅	✅	✅
Embed	✅	✅	✅	✅
Emoji	❌	❌	❌	✅
Frame	✅	✅	✅	✅
Image	✅	✅	✅	✅
Kanban	❌	❌	❌	❌
Mindmap	❌	❌	❌	❌
Organization (Enterprise plan only)	❌	✅	❌	❌
Organization member (Enterprise plan only)	❌	✅	❌	❌
Projects (Enterprise plan only)	✅	✅	✅	✅
Project Settings (Enterprise plan only)	❌	✅	✅	❌
Project Members(Enterprise plan only)	`✅`	`✅`	`✅`	`✅`
Preview	❌	❌	❌	✅
Shape	✅	✅	✅	✅
Sticky note	✅	✅	✅	✅
Stroke	❌	❌	❌	❌
SVG	❌	❌	❌	✅
Grid	❌	❌	❌	❌
Tag	✅	✅	✅	✅
Team (Enterprise plan only)	✅	✅	✅	✅
Team member (Enterprise plan only)	✅	✅	✅	✅
Team settings (Enterprise plan only)	❌	✅	✅	❌
Text	✅	✅	✅	✅
USM	❌	❌	❌	❌
Webhook	✅	✅	✅	✅
Webscreen	❌	❌	❌	❌
Wireframe	❌	❌	❌	❌
Beta widgets
Doc	❌	✅	❌	❌
Slides	❌	❌	❌	❌
Table	❌	❌	❌	❌
Timeline	❌	❌	❌	❌

What can I do with the REST API?

📘These APIs are free to use. Only a Miro account and developer team is needed. See our quickstart guide and video on how to get started using our REST APIs.

📘
These APIs are free to use. Only a Miro account and developer team is needed. See our quickstart guide and video on how to get started using our REST APIs.