Jump to Content

MCP Documentation Resources Marketplace Community

Documentation API Reference Changelog

main

MCP Documentation Resources Marketplace Community Build your app

API Reference

main

Authorization

Introduction
Permission scopes
Rate limiting
Getting Started with OAuth 2.0 and Miro
Authorization flow for expiring tokens
Authorization flow for non-expiring access tokens

Access tokens

Revoke token (v2)post
Get access token contextget
Revoke tokenpost

Platform

Boards
App card items
Card items
Connectors
Document items
Embed items
Image items
Items
Board members
Shape items
Sticky note items
Text items

Doc Formats

doc formats

Groups

Create grouppost
Get all groups on a boardget
Get items of a group by IDget
Get a group by its IDget
Ungroup itemsdel
Updates a group with new itemsput
Deletes the groupdel

Create items in bulk

Create items in bulk using file from devicepost
- JSON file example
Create items in bulkpost

TAGS

Get items by tagget
Attach tag to itempost
Remove tag from itemdel
Get tags from itemget
Create tagpost
Get tags from boardget
Get tagget
Update tagpatch
Delete tagdel

Platform Containers

frames
items
- Get items within frameget

Miro oEmbed API

Get oEmbed dataget

Platform Experimental Features

App metrics (experimental)
- Get app metricsget
- Get total app metricsget
Mind map nodes (experimental)
Flowchart shapes (experimental)

Projects (Enterprise Plan)

Projects
Project Settings
- Get project settingsget
- Update project settingspatch
Project Members

Organizations (Enterprise Plan)

Organizations
- Get organization infoget
Organization Members
- Get organization membersget
- Get organization memberget

Teams (Enterprise Plan)

Teams
Team Settings
Team Members

Enterprise User Session Reset (Enterprise Plan)

Reset all sessions of a user
- Reset all sessions of a userpost

Board Classification (Enterprise Plan)

Board classification: Organization level
- Get organization settingsget
Board classification: Team level
Board classification: Board level
- Get board classificationget
- Update board classificationpost

Audit Logs (Enterprise Plan)

Audit Logs
- Get audit logsget

User Groups (Enterprise Plan)

User groups
User group members
User group to teams
- Get teams of a user groupget
- Get user group teamget
Share boards with groups
Share projects with groups
Team user groups

eDiscovery (Enterprise Guard)

Board Export
Board Content Logs
- Retrieve content change logs of board itemsget
Legal holds

Miro SCIM API

Introduction
Rate limits
User lifecycle management
Getting started
Discovery
User
Group

AI Interaction Logs (Enterprise Guard)

AI Interaction Logs
- Get AI interaction logs (Beta)get

Powered by

Get oEmbed data

get

https://miro.com/api/v1/oembed

Retrieves information to embed a Miro board as a live embed.

Language

Response

Click Try It! to start a request and see the response here!