For AI agents: the docs index is at https://developers.miro.com/llms.txt. Append .md to any documentation page URL to get its markdown version.
Jump to Content
MCP
Documentation
Resources
Marketplace
Community
Documentation
API Reference
Changelog
main
MCP
Documentation
Resources
Marketplace
Community
Build your app
API Reference
Build your app
main
API Reference
Introduction
Authorization
Introduction
Permission scopes
Rate limiting
Getting Started with OAuth 2.0 and Miro
Authorization flow for expiring tokens
Step 1: Create authorization request link
Step 2: Request user for authorization
Step 3: Exchange authorization code with access token
post
Step 4: Use access token for REST API requests
Step 5: Get new access token using refresh token
Authorization flow for non-expiring access tokens
Step 1: Create authorization request link
Step 2: Request the user for authorization
Step 4: Use access token for REST API requests
Platform
Auth
Get access token context
get
Revoke token (v2)
post
Boards
Create board
post
Get boards
get
Copy board
put
Get specific board
get
Update board
patch
Delete board
del
Bulk operations
Create items in bulk
post
JSON file example
App card items
Create app card item
post
Get app card item
get
Update app card item
patch
Delete app card item
del
Items
Connectors
Create connector
post
Get connectors
get
Get specific connector
get
Update connector
patch
Delete connector
del
Card items
Create card item
post
Get card item
get
Update card item
patch
Delete card item
del
Doc Format
Create doc format item
post
Get doc format item
get
Delete doc format item
del
Document items
Create document item using file from device
post
Update document item using file from device
patch
Create document item using URL
post
Get document item
get
Update document item using URL
patch
Delete document item
del
Embed items
Create embed item
post
Get embed item
get
Update embed item
patch
Delete embed item
del
Frames
Get items within frame
get
Create frame
post
Get frame
get
Update frame
patch
Delete frame
del
Image items
Update image item using file from device
patch
Create image item using file from device
post
Create image item using URL
post
Get image item
get
Update image item using URL
patch
Delete image item
del
Items
Get items on board
get
Get specific item on board
get
Update item position or parent
patch
Delete item
del
Groups
Create group
post
Get all groups on a board
get
Get items of a group by ID
get
Get a group by its ID
get
Ungroup items
del
Updates a group with new items
put
Deletes the group
del
Board members
Share board
post
Get all board members
get
Get specific board member
get
Update board member
patch
Remove board member
del
Shape items
Create shape item
post
Get shape item
get
Update shape item
patch
Delete shape item
del
Sticky note items
Create sticky note item
post
Get sticky note item
get
Update sticky note item
patch
Delete sticky note item
del
Tags
Update tag
patch
Get tag
get
Get tags from board
get
Create tag
post
Get tags from item
get
Remove tag from item
del
Attach tag to item
post
Get items by tag
get
Text items
Create text item
post
Get text item
get
Update text item
patch
Delete text item
del
Platform Experimental Features
Mind map nodes (experimental)
Get specific mind map node
get
Delete mind map node
del
Get mind map nodes
get
Create mind map node
post
Flowchart shapes (experimental)
Get items on board
get
Get specific item on board
get
Create shape item
post
Get shape item
get
Update shape item
patch
Delete shape item
del
Experimental Items
Delete item
del
Code widget items (experimental)
Get code widget items
get
Create code widget item
post
Get code widget item
get
Update code widget item
patch
Delete code widget item
del
Move code widget item
patch
Miro oEmbed API
Get oEmbed data
get
Projects (Enterprise Plan)
Projects
Create project
post
List of projects
get
Get project
get
Update project
patch
Delete project
del
Project Settings
Get project settings
get
Update project settings
patch
Project Members
Add member in a project
post
List of project members
get
Get project member
get
Update project member
patch
Remove project member
del
Organizations (Enterprise Plan)
Organizations
Get organization info
get
Organization Members
Get organization members
get
Get organization member
get
Teams (Enterprise Plan)
Teams
Create team
post
List teams