Jump to Content
Miro Developer PlatformMiro Developer PlatformMCPDocumentationResourcesMarketplaceCommunity
DocumentationAPI ReferenceChangelog
main

MCPDocumentationResourcesMarketplaceCommunityBuild your appMiro Developer Platform
API Reference
Build your app
main

Platform

  • Auth
    • Get access token contextget
    • Revoke token (v2)post
  • Boards
    • Create boardpost
    • Get boardsget
    • Copy boardput
    • Get specific boardget
    • Update boardpatch
    • Delete boarddel
    • Create boardpost
    • Get boardsget
    • Copy boardput
    • Get specific boardget
    • Update boardpatch
    • Delete boarddel
  • Bulk operations
    • Create items in bulkpost
    • JSON file example
  • App card items
    • Create app card itempost
    • Get app card itemget
    • Update app card itempatch
    • Delete app card itemdel
    • Create app card itempost
    • Get app card itemget
    • Update app card itempatch
    • Delete app card itemdel
  • Items
    • Get items on boardget
    • Get specific item on boardget
    • Update item position or parentpatch
    • Delete itemdel
  • Connectors
    • Create connectorpost
    • Get connectorsget
    • Get specific connectorget
    • Update connectorpatch
    • Delete connectordel
    • Create connectorpost
    • Get connectorsget
    • Get specific connectorget
    • Update connectorpatch
    • Delete connectordel
  • Card items
    • Create card itempost
    • Get card itemget
    • Update card itempatch
    • Delete card itemdel
    • Create card itempost
    • Get card itemget
    • Update card itempatch
    • Delete card itemdel
  • Doc Format
    • Create doc format itempost
    • Get doc format itemget
    • Delete doc format itemdel
  • Document items
    • Create document item using file from devicepost
    • Update document item using file from devicepatch
    • Create document item using URLpost
    • Get document itemget
    • Update document item using URLpatch
    • Delete document itemdel
    • Create document item using URLpost
    • Get document itemget
    • Update document item using URLpatch
    • Delete document itemdel
  • Embed items
    • Create embed itempost
    • Get embed itemget
    • Update embed itempatch
    • Delete embed itemdel
    • Create embed itempost
    • Get embed itemget
    • Update embed itempatch
    • Delete embed itemdel
  • Frames
    • Get items within frameget
    • Create framepost
    • Get frameget
    • Update framepatch
    • Delete framedel
  • Image items
    • Update image item using file from devicepatch
    • Create image item using file from devicepost
    • Create image item using URLpost
    • Get image itemget
    • Update image item using URLpatch
    • Delete image itemdel
    • Create image item using URLpost
    • Get image itemget
    • Update image item using URLpatch
    • Delete image itemdel
  • Items
    • Get items on boardget
    • Get specific item on boardget
    • Update item position or parentpatch
    • Delete itemdel
  • 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
  • Board members
    • Share boardpost
    • Get all board membersget
    • Get specific board memberget
    • Update board memberpatch
    • Remove board memberdel
    • Share boardpost
    • Get all board membersget
    • Get specific board memberget
    • Update board memberpatch
    • Remove board memberdel
  • Shape items
    • Create shape itempost
    • Get shape itemget
    • Update shape itempatch
    • Delete shape itemdel
    • Create shape itempost
    • Get shape itemget
    • Update shape itempatch
    • Delete shape itemdel
  • Sticky note items
    • Create sticky note itempost
    • Get sticky note itemget
    • Update sticky note itempatch
    • Delete sticky note itemdel
    • Create sticky note itempost
    • Get sticky note itemget
    • Update sticky note itempatch
    • Delete sticky note itemdel
  • Tags
    • Update tagpatch
    • Get tagget
    • Get tags from boardget
    • Create tagpost
    • Get tags from itemget
    • Remove tag from itemdel
    • Attach tag to itempost
    • Get items by tagget
  • Text items
    • Create text itempost
    • Get text itemget
    • Update text itempatch
    • Delete text itemdel
    • Create text itempost
    • Get text itemget
    • Update text itempatch
    • Delete text itemdel

Platform Tag

    • Delete tagdel

Platform Experimental Features

  • Mind map nodes (experimental)
    • Get specific mind map nodeget
    • Delete mind map nodedel
    • Get mind map nodesget
    • Create mind map nodepost
  • Flowchart shapes (experimental)
    • Get items on boardget
    • Get specific item on boardget
    • Create shape itempost
    • Get shape itemget
    • Update shape itempatch
    • Delete shape itemdel
  • Experimental Items
    • Delete itemdel
  • Code widget items (experimental)
    • Get code widget itemsget
    • Create code widget itempost
    • Get code widget itemget
    • Update code widget itempatch
    • Delete code widget itemdel
    • Move code widget itempatch

Projects (Enterprise Plan)

  • Projects
    • Create projectpost
    • List of projectsget
    • Get projectget
    • Update projectpatch
    • Delete projectdel
  • Project Settings
    • Get project settingsget
    • Update project settingspatch
  • Project Members
    • Add member in a projectpost
    • List of project membersget
    • Get project memberget
    • Update project memberpatch
    • Remove project memberdel

Organizations (Enterprise Plan)

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

Teams (Enterprise Plan)

  • Teams
    • Create teampost
    • List teamsget
    • Get teamget
    • Update teampatch
    • Delete teamdel
  • Team Settings
    • Get default team settingsget
    • Get team settingsget
    • Update team settingspatch
  • Team Members
    • Invite team memberspost
    • List team membersget
    • Get team memberget
    • Update team memberpatch
    • Delete team member from teamdel

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
    • Bulk update boards classificationpatch
    • Get team settingsget
    • Update team settingspatch
  • Board classification: Board level
    • Get board classificationget
    • Update board classificationpost

Audit Logs (Enterprise Plan)

  • Audit Logs
    • Get audit logsget

Platform File Upload

  • documents

User Groups (Enterprise Plan)

  • User groups
    • List of user groupsget
    • Create user grouppost
    • Get user groupget
    • Update user grouppatch
    • Delete user groupdel
  • User group members
    • List of user group membersget
    • Create user group memberpost
    • Bulk edit of membership in user grouppatch
    • Get user group memberget
    • Delete user group memberdel
  • User group to teams
    • Get teams of a user groupget
    • Get user group teamget
  • Share boards with groups
    • Get board user group assignmentsget
    • Create board user group assignmentspost
    • Delete board user group assignmentdel
  • Share projects with groups
    • Get project user group assignmentsget
    • Create project user group assignmentspost
    • Delete project user group assignmentdel
  • Team user groups
    • List of user group to team connectionsget
    • Create user group to team connectionpost
    • Get user group of a teamget
    • Delete user group to team connectiondel

eDiscovery (Enterprise Guard)

  • Board Export
    • Create board export jobpost
    • Get board export jobs listget
    • Get board export job statusget
    • Get results for board export jobget
    • Update board export job statusput
    • Get board export job tasks listget
    • Create task export linkpost
  • Board Content Logs
    • Retrieve content change logs of board itemsget
  • Legal holds
    • Get all casesget
    • Create casepost
    • Close casedel
    • Get caseget
    • Edit caseput
    • Get all legal holds within a caseget
    • Create legal holdpost
    • Get board export jobs of a caseget
    • Close legal holddel
    • Get legal hold informationget
    • Edit legal holdput
    • Get content items under legal holdget

Miro SCIM API

  • Introduction
  • Getting started
  • User lifecycle management
  • Discovery
    • Get Service Provider Configget
    • List resource typesget
    • Get resource typeget
    • List schemasget
    • Get schemaget
  • User
    • List usersget
    • Create userpost
    • Get userget
    • Replace userput
    • Patch userpatch
    • Delete userdel
  • Group
    • List groupsget
    • Get groupget
    • Patch grouppatch
    • Create grouppost
    • Delete groupdel

AI Interaction Logs (Enterprise Guard)

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

Miro oEmbed API

  • Get oEmbed dataget

Miro SCIM API (legacy, team-based)

  • Discovery
    • Get Service Provider Configget
    • List resource typesget
    • Get resource typeget
    • List schemasget
    • Get schemaget
  • User
    • List usersget
    • Create userpost
    • Get userget
    • Replace userput
    • Patch userpatch
    • Delete userdel
  • Group
    • List groupsget
    • Get groupget
    • Patch grouppatch

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 tokenpost
    • 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
Powered by 

documents

Updated 3 months ago


Get audit logs
User groups
Did this page help you?

Updated 3 months ago


Get audit logs
User groups
Did this page help you?