For AI agents: visit https://developers.miro.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI. 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
Items
JUMP TO
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
get
Get team
get
Update team
patch
Delete team
del
Team Settings
Get default team settings
get
Get team settings
get
Update team settings
patch
Team Members
Invite team members
post
List team members
get
Get team member
get
Update team member
patch
Delete team member from team
del
Enterprise User Session Reset (Enterprise Plan)
Reset all sessions of a user
Reset all sessions of a user
post
Board Classification (Enterprise Plan)
Board classification: Organization level
Get organization settings
get
Board classification: Team level
Bulk update boards classification
patch
Get team settings
get
Update team settings
patch
Board classification: Board level
Get board classification
get
Update board classification
post
Audit Logs (Enterprise Plan)
Audit Logs
Get audit logs
get
User Groups (Enterprise Plan)
User groups
List of user groups
get
Create user group
post
Get user group
get
Update user group
patch
Delete user group
del
User group members
List of user group members
get
Create user group member
post
Bulk edit of membership in user group
patch
Get user group member
get
Delete user group member
del
User group to teams
Get teams of a user group
get
Get user group team
get
Share boards with groups
Get board user group assignments
get
Create board user group assignments
post
Delete board user group assignment
del
Share projects with groups
Get project user group assignments
get
Create project user group assignments
post
Delete project user group assignment
del
Team user groups
List of user group to team connections
get
Create user group to team connection
post
Get user group of a team
get
Delete user group to team connection
del
eDiscovery (Enterprise Guard)
Board Export
Create board export job
post
Get board export jobs list
get
Get board export job status
get
Get results for board export job
get
Update board export job status
put
Get board export job tasks list
get
Create task export link
post
Board Content Logs
Retrieve content change logs of board items
get
Legal holds
Get all cases
get
Create case
post
Close case
del
Get case
get
Edit case
put
Get all legal holds within a case
get
Create legal hold
post
Get board export jobs of a case
get
Close legal hold
del
Get legal hold information
get
Edit legal hold
put
Get content items under legal hold
get
Miro SCIM API
Introduction
Getting started
User lifecycle management
Discovery
Get Service Provider Config
get
List resource types
get
Get resource type
get
List schemas
get
Get schema
get
User
List users
get
Create user
post
Get user
get
Replace user
put
Patch user
patch
Delete user
del
Group
List groups
get
Get group
get
Patch group
patch
Create group
post
Delete group
del
Miro SCIM API (legacy, team-based)
Discovery
Get Service Provider Config
get
List resource types
get
Get resource type
get
List schemas
get
Get schema
get
User
List users
get
Create user
post
Get user
get
Replace user
put
Patch user
patch
Delete user
del
Group
List groups
get
Get group
get
Patch group
patch
AI Interaction Logs (Enterprise Guard)
AI Interaction Logs
Get AI interaction logs (Beta)
get
Platform Tags
tags
Delete tag
del
Powered by
Items
Updated 2 months ago
Delete app card item
Connectors
Did this page help you?
Yes
No
Updated 2 months ago
Delete app card item
Connectors
Did this page help you?
Yes
No
