Skip to main content

Developer platform and APIs

Discuss everything related to Miro API, SDK, embedding and Miro Platform apps development.

  • 1,040 Topics
  • 3,272 Replies
1038 Topics
William Bishop
Mironeer
William BishopMironeer
posted in Developer platform and APIs
Video Clipper: Spend your time where it matters

There's a new app in the market that you might want to check out: Video Clipper. You can now upload videos, generate transcriptions and create playable clips right on your Miro board. A must-have for UX Researchers or anyone that wants to digest and gain insights from user interviews, recorded meetings, and video-inclusive brainstorming. Free your time to focus on analyzing the results. Let the app take care of video editing and transcribing.Try it now!

3606
Robert Johnson
F
FrankieFXBeginner
asked in Developer platform and APIs
Google Documents paste

HI! I was pasting a google doc once and accidentally didn't give permission or something. and now when I try to paste the doc I get this result. I've tried a lot of things, going through the settings, giving access, installing plugins. but nothing works. Can you please tell me how to fix this?   

946
Robert Johnson
Ben Mort
Ben MortBeginner
asked in Developer platform and APIs
Is there any way to change a card widget fill color through the REST or Web APIs?

I would like to be able to change the background fill colour for card widgets though the API (REST or otherwise) but have not been able to find a way of doing this? Am I just being blind or is this not exposed? I can do this via the web UI with the slider at the top of the option to change the card color.

17138
Eca
Mironeer
Ben Mort
Ben MortBeginner
posted in Developer platform and APIs
Why is it possible to set card colour for standard cards but not Jira cards through the Web SDK API?

As noted in this thread https://community.miro.com/developer-platform-and-apis-57/is-there-any-way-to-change-a-card-widget-fill-color-through-the-rest-or-web-apis-2161?postid=8939#post8939 its possible to set card colours and fill using the Web SDK API. What seems not to be possible though yet for some reason using the Web SDK v2 is to set the card colours for Jira Cards using the same commands.Is this intended? Does anyone know of a work around?What I would like to do is be able to programatically set the colour of cards based on a card property, for example the Jira card priority field. While the Jira cards app does not support this natively yet and even if it did, it would be very convenient if the API allowed this since its supported in the UI. Many thanks!

872
Ben Mort
A
AdityaMiroAetherBeginner
asked in Developer platform and APIs
MindMap JSON does not maintain Node Hierarchy ?

I have a requirement where I am using Miro to create a Mind map. I want to extract the Json from this Mind Map and use the information in that Json to trigger further steps. I am fetching the JSON on my board via REST api.The problem I see is that the hierarchy which I created in the Mind map on my Miro board is not maintained in the fetched Json (through REST Api).All the nodes are given individually. There is a property of “parent” with links but looks like that it is representing a root parent and not the immediate parent of that particular node.I need to derive relationship between a Node and its immediate parent Node and Child Nodes through this JSON. Q1.  How can I do this ? Am i missing something in generated JSON which helps to get information of the immediate parent and child nodes of a particular node ?Q2.  Is there a support of the Gantt Chart in Miro ?Q3. Also, is there a way to get all the information of a MindMap rather than requesting again and again for 50 nodes ? Thank

1395
Mettin
Mironeer
N
NickJohnsonNew Here
asked in Developer platform and APIs
How to download images from the API with good resolution?

I download images from the API like this(Let's say there's only one image on my board.):I call https://api.miro.com/v2/boards/{board_id}/itemsI make a request using the imageUrl field that I received from the response (with authorization)I receive json in the response "url": "https://r.miro.com/..,     "type": "image"Using the received url I download imageBut the image is downloaded in poor resolutionPlease tell me how to download images from the API?

1101
Horea Porutiu
Mironeer
Fry
FryBeginner
posted in Developer platform and APIs
Miro Webhooks

Externally, I would like to know when certain changes are made to the Miro Board. I loath polling and comparison models.I think toying with the idea of making an Heroku or Glitch web-plugin that monitors the events of the board and sends a POST request to an external system.Is anyone else doing anything similar? 

169025
A
G
gitbleiddNew Here
posted in Developer platform and APIs
Bug with REST Update board method

Hi, hope this is the right place to feed back with an api bug report.I think there's possible a bug with https://developers.miro.com/reference/update-boardBoards updates but for some reason server returns internal error, maybe my request is incorrect.I’ve attached request and response logs without bearer token.Thanks for the support,VasilyRequest:Method: PATCH, RequestUri: 'https://api.miro.com/v2/boards/uXjVPMm5xU4%3d', Version: 1.1, Content: System.Net.Http.StringContent, Headers:{ Accept: application/json Authorization: Bearer Content-Type: application/json}{"description":"some new description","name":"Test","policy":{"permissionsPolicy":{"collaborationToolsStartAccess":"all_editors","copyAccess":"anyone","sharingAccess":"team_members_with_editing_rights"},"sharingPolicy":{"access":"view","inviteToAccountAndBoardLinkAccess":"viewer","organizationAccess":"private","teamAccess":"edit"}},"teamId":"3458764536059967553"}Response:StatusCode: 500, ReasonPhrase: 'Server Error', Version:

1794
N
A
Alina ShvedovaBeginner
asked in Developer platform and APIs
How can I get 100+ AI credits?

Hello!My question is "How can I get 100+ AI Credits?"I'm interior designer and I use AI to remove background while creating inteior collages. Then I share the page with my assisnat and client. It's multipurpose -- that's why I love Miro so much. I've just found out that my Business plan provides of only 50 "remove background”-iterations. That's too bad. I use "remove background" at least 50 times a week. Now I'm concerned whether I should cancel my Business-subscription and switch to another app with unlimited AI credits (I use "remove background" to make interior collages)Thank you for your advices! 

1101
ElvaMiro
Mironeer
N
Neil MehtaBeginner
asked in Developer platform and APIs
Miro Web SDK 2.0 Error - Miro Not Defined and Missing _sdk parameter

For the past week, I have been having an issue with the Miro Web SDK :(First a little background! -I have created an plain TS/JS app for my organization following the Miro Developer documentation (great docs btw). We are leveraging the Azure environment to host our app through Azure Static Web Apps pulling from Azure Dev Ops. The app is leveraging the Miro Web SDK to enable app icon click (miro.board.ui.openPanel method), modals (miro.board.ui.openModal method), a drag-and-drop feature (miro.board.ui.on method), and it also gets the current user (miro.board.getUserInfo method). Until 1 week ago, the app was working perfectly, however since last Wednesday (07/24/24) certain features of the app have not. After checking the logs, I realized the code hung up when instantiating the miro sdk using the openModal method and ui.on methods. I was also getting the following error in the Miro Developer console.  The first and third lines are expected and codified. So, here we have two errors. One

2209
N
M
mistletoeNew Here
asked in Developer platform and APIs
How can I change Sticky Note’s font size?

Hey Guys.I wanna change Sticky Note’s font size bia Miro’s SDK or API.I wanna make Miro app to fix Sticky Note’s font size for easy to see.I’ve watched reference page, but I can’t find it.https://developers.miro.com/docs/websdk-reference-sticky-note

1181
Horea Porutiu
Mironeer
I
Ivan HomolaNew Here
asked in Developer platform and APIs
How to get notifications about new comments

Hey,We are building an integration similar to Miro → Slack integration.I’m looking for an option to deliver notification functionality into our integration. I know you can get notified when someone mentioned you in the comments or when someone comments on a thread you follow.I went through Miro API, but I could not find any webhooks or info related to comments on a board. Is it possible to create such a feature? Thank you! 

2774
Horea Porutiu
Mironeer
Sami Ljimari
Sami LjimariActive Contributor
asked in Developer platform and APIs
Migrating V1 SDK to V2 iframe Error

I have been approached to migrate a board app / extension not sure what they are called now which is using V1 SDK to V2From the documentation on how apps are created in V2 everything seems unchanged in the initialization section, apart from referencing the new SDK url ofcourseHowever when I try to fire up the code in a new app which has V2 selected I get this:ErrorCouldn’t find any explanation in docs as to what this could mean.Are there any auth / security header changes that a server needs to meet when initializing the iframe panel compared to V1? Just for context, I do not expect the functionality of my old V1 code to work at all on V2, but I did expect the iframe to fire up and greet me with errors which I could then debug one by one. I tried adding log calls throughout the code but none display in my browser console, meaning that this error most likely obstructs the script from ever even firing, and the same goes for the HTML, whatever change I make to it does not get shown in the

683
Horea Porutiu
Mironeer
P
Paul ListerNew Here
asked in Developer platform and APIs
How do I find out who has developed using the V1 platform?

HiI recently got a message saying this:And I have no idea how to find the developers who have created these apps…...can someone tell me how I can find this info?

571
Robert Johnson
K
KangLengBeginner
asked in Developer platform and APIs
Getting user name based on ID in Web SDK

I want to keep my app simple and only use Web SDK and does not want to integrated with Rest API.I am currently exporting list of board item to an external system. However, the createdBy and modifiedBy are returning an userId.  As userId is not readable in this case. I had check through the webSDK documentation and could not find any method to retrieve a username by id. Is there any method to support this other than Rest API?

1234
T
Clyde D'Souza
Clyde D'SouzaGroup Leader
asked in Developer platform and APIs
Miro API copyBoard not available?

Hi!I was trying to follow this API docs https://developers.miro.com/reference/copy-board and was hoping to use the copyBoard() in my React app but it doesn’t seem to exists in the latest npm package. I’ve installed "@mirohq/websdk-types": "^2.15.1", and I’m including  <script src="https://miro.com/app/static/sdk/v2/miro.js"></script> in the index.html file.    Am I missing something?

502
Clyde D'Souza
Clyde D'Souza
Clyde D'SouzaGroup Leader
asked in Developer platform and APIs
Restricted release of a Miro app?

Hi, I’m developing a Miro app and was wondering if there was an option to make it available to only a group of individuals (public) to gain initial feedback before making it generally available? Thanks

472
Clyde D'Souza
M
Manuel HessBeginner
posted in Developer platform and APIs
Prevent scrolling in embeded Miro board

Hi everybody, I am currently working on a web based prototype that integrates different areas of a Miro board via iframes. I currently face the following challenge:When you load a web page that integrates a part of a Miro board via iframe and scroll down the page, the mouse gets capture in the iframe and you continue scrolling within the Miro board. So you happen to have a completely different area of the board visible in the iframe.Any chance to prevent this? So ideally kind of fixing the area of the board that is visible in the iframe?As a workaround I put a button below the iframes that simply reloads the iframe and thereby “centers” the view again. But that’s not very usery friendly. Thanks for helping!

6609
Horea Porutiu
Mironeer
R
Rajeev KumarBeginner
posted in Developer platform and APIs
Integrating diagramming apps

I am looking to integrate a diagramming app with Miro. I am planning to do the way draw.io is integrated. But I did not find anything in the documentation on this topic. Is the draw.io integration done using all documented (and supported) API? Can someone point me to any related documentation.  Thanks 

1136
Horea Porutiu
Mironeer
A
Adib ZainiBeginner
asked in Developer platform and APIs
I tried to submit my app to Miro marketplace but encounter this error (400)

I tried to submit my app to Miro marketplace but encounter this errorLooks like the error on `appId` In the payload, `appId` is empty. I think this problem is on Miro side?

963
A
Z
ZyadNew Here
asked in Developer platform and APIs
Can Miro work with Power Automate and is it possible to automate download of a board weekly?

Hi team,My manager is looking to see if its possible to create a Power Automate flow that would download weekly Miro boards and save in the drive. Is this possible?

2191
A
Mironeer
Mira Balani
Mironeer
Mira BalaniMironeer
posted in Developer platform and APIs
The Miro Web SDK 2.0 introduces mind maps

Good day Miro developers! 😃 We have some good news to share! The Miro Web SDK 2.0 introduces mind maps in its experimental release today. Create, read, update, or delete mind maps to programmatically represent and interact with complex structures of information into Miro boards. With minimal development effort, you can also seamlessly import and export from third-party tools, or transform mind map information into other item types in Miro.For more information, do check out the following resources:Mind maps change log Mind maps overview Mind maps reference guide How-to guide on creating a mind map from a CSV fileHave fun trying it out! Cheers,Mira  

1496
S
Fredrik Wendt
Fredrik WendtContributor
posted in Developer platform and APIs
Changing User's Pictures through REST API v2

Now that you’ve sunset https://api.miro.com/v1/users/USERID/picture - what’s the preferred way to do this without having to plug in som SCIM solution? (I couldn’t find any mentioning of Picture in the REST API v2 docs.)We’ve been on the consultant plan (there’s 13 of us), will we have to update to Enterprise plan to sync titles and photos with Miro?

491
Horea Porutiu
Mironeer
M
Mohammed SameerBeginner
asked in Developer platform and APIs
Where can I find exhaustive list of all Webhook events supported by REST API?

I am making a Miro app that uses REST API.I want to handle all events in my app thus want to know list of all webhook event types.

826
Horea Porutiu
Mironeer
A
andrejjNew Here
asked in Developer platform and APIs
Miro rest api web hooks

Hello. I’m trying to make miro → discord integration and I need to setup webhook to get updates from miro board to notify people on discord about certain events. Is it currently possible (couldn’t find any webhook mention in Miro API)?Is there any plans to add webhooks to Miro API in near future? My team is currently migrating from Trello to Miro and this is the only inconvenience we’ve met that we can’t move our discord notifications system from Trello to Miro.

2614
Horea Porutiu
Mironeer
Terms & Conditions