Skip to main content

Developer platform and APIs

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

  • 1,051 Topics
  • 3,286 Replies
1046 Topics
S
Siddhant KumarNew Here
asked in Developer platform and APIs
Sorry, integration is unavailable.

When i tring to use  this is code miroBoardsPicker.open({ clientId: '***********', // Replace it with your app ClientId action: actionSelect.value, success: (data) => { resultsBox.innerHTML = JSON.stringify(data, null, 4) resultsBox.style.display = "block" } }) it is giving me error in console Error. Account is not a partner. Reason is accountIsNotPlatformPartner   and on chrome popup Sorry, integration is unavailable.

191513
Boris Borodyansky
Mironeer
M
marcfonBeginner
asked in Developer platform and APIs
How to get the metadata for a preview type item?

How do I get the metadata from an `preview` type item? The preview items contain urls to external pages that I need to extract. [ { "output": [ { "id": "3458764612000528999", "type": "preview", "geometry": { "width": 250, "height": 223.5234375 }, "position": { "x": -340.9169006347656, "y": -154.68751525878906, "origin": "center", "relativeTo": "canvas_center" }, "links": { "self": "https://api.miro.com/v2/boards/uXjVLyMfaRI%3D/items/3458764612000528999" }, "createdAt": "2025-01-01T19:01:43Z", "createdBy": { "id": "3074457346783176524", "type": "user" }, "isSupported": false, "modifiedAt": "2025-01-01T19:01:43Z", "modifiedBy": { "id": "3074457346783176524", "type": "user" } } ] }] I also found that when you slect type `preview` from the dropdown in the official api doc

8813
Horea Porutiu
Mironeer
S
SandroContributor
posted in Developer platform and APIs
Boards API endpoint does not return all boards

Hi allI am trying to establish a lifecycle process with the Miro api. I’ve created a miro app (draft status) and installed it in a team (install app and get oauth token). With this token I’ve used the /boards api endpoint like so: GET https://api.miro.com/v2/boards/?limit=50&offset=0accept: application/jsonAuthorization: Bearer [oauth token] I get back a json saying there is a total of 403 boards in this team:{ "size": 50, "offset": 0, "limit": 50, "total": 403,//[..removed]}However in the Admin portal I can see that there should be more boards in this team (552). How can this be? (the trash is empty). I have the company admin role.The app has the following permissions: Is this because my user cannot see all boards (e.g. private) - even if I am company admin?  Thanks for your support! 

16813
Horea Porutiu
Mironeer
D
delezeNew Here
posted in Developer platform and APIs
REST API how to export frame to image

Hi all,How to export a frame as image using the REST API ?Thank you for your support!

78713
Horea Porutiu
Mironeer
Abhijeet Narvekar
Abhijeet NarvekarNew Here
posted in Developer platform and APIs
Web Plugin: Select Text In Widget

Hi,I am developing a web plugin for Miro. I want to select text inside a TextWidget. (As shown below)Couldn’t find any documentation if it possible to highlight text inside a widgetAny suggestions? Best,Abhijeet​​​​​​​

26112
Marco Spinello
Mironeer
A
Admin AdminBeginner
posted in Developer platform and APIs
Normal team board not able to integrate into my website using API

Hi Team,I have subscribed started plan in Miro and integrated the Miro in my website, I can able to see the dev team boards but not able to see the normal boards, I am getting the below error. I am suspecting this issue could because of I configured the client id of dev team, couldn’t able to create/see the client id for normal team board. My objective is integrate the normal team board, not the dev team board. What should I do?

11512
Marco Spinello
Mironeer
H
HarshitaVishwakarmaContributor
posted in Developer platform and APIs
Is there any way to list the teams a user is a part of using REST API ?

I have a requirement to fetch the list of teams a user is a part ofPlease help on how I can achieve this? 

15512
H
J
Joseph LowBeginner
posted in Developer platform and APIs
How to make a sidebar plugin, rather than a pop-up plugin

Hey all, I’m working on developing a Miro plugin and would like to find out how I can make my plugin take up the sidebar, rather than opening up as a pop-up. I’ve attached a screenshot of the difference between the sidebar and pop-up plugins which I am referring to (Let me know if there is a correct way to name these!). The documentation only has openPanel and openModal which do not work for me. Any help would be much appreciated!  Cheers!  BoardUI DocumentationSidebar PluginPop-up Plugin 

23512
N
S
Sathiamoorthy MBeginner
posted in Developer platform and APIs
Export board Image or PDF using API

Hi,How to export the miro board as Image, Pdf or any other format. Someone could please help me out, I need this feature.Regards,Sathia

125612
William Bishop
Mironeer
S
shin_yasueBeginner
posted in Developer platform and APIs
Can I add my own shapes?

I am new to MIRO and English, so sorry if this is a strange question.Is it possible to add my own shapes using the API?Specifically, I would like to be able to drag and drop a shape like a crown onto the board.I have used SVG before, but I want to change the color of the lines and the background color, so I want to achieve this with shapes.Please give me some ideas!

945312
Addison Schultz
Mironeer
A
Alberto GirettiBeginner
posted in Developer platform and APIs
BottomPanel does not work anymore

Hello everyoneI've been developing the Kobi application for a few months now, using the BottomBar as a tool to select the app’s main functions.The code I use is almost identical to what is published in the sdk 1.1 documentation (see code in appendix). Furthermore, everything worked without any problems for several months.However, for a couple of weeks now the BottomPanel no longer appears.Are there any specific reasons for the transition to sdk 2.0 why this is happening, or some other reason I am not aware of? In any case, is there any workaround?Thanks for everything Alberto-----Appendix the code used. miro.initialize({    extensionPoints: {      bottomBar: {        title: `Kobi`,        svgIcon: Kobi,        onClick: () => {          miro.board.ui.openBottomPanel("kobipanel.html", {width: 204,height: 48,});          },        },      getWidgetMenuItems: (widgets) => {        return Promise.resolve([{          tooltip: 'show',          svgIcon: Kobieye,          onClick: (widget

24912
Joanna Smith
Mironeer
M
Mark McIntyreBeginner
asked in Developer platform and APIs
Sketch Miro Problem eoor during syncing after upgrading to Sketch 87.1

I had an existing Sketch file which was working fine when we used the Miro plugin it sync the artboard to Miro. We could work without issue, update the artboard on the Sketch file and then resync to miroThis would then replace any existing instance with the update art boardWe upgraded to Sketch 87.1.Now if we try an resync it to the Miro board we get an error“An error occured.There was an error during syncing. Please Try again”If we create new artboard in the doc and sync that it works as expected. Plus we can update and resync without issue. 

17411
J
M
Mark McIntyreBeginner
posted in Developer platform and APIs
Unable to search image names

Ive noticed if you upload an image called New_option1.jpg  you used to be able to use Miro search and type in the search inside Miro for a part of the name eg “new” or “option” and it would appear in the search.Now nothing at all comes comes up for some reason? Why is that

13011
Robert Johnson
M
mt0922Beginner
asked in Developer platform and APIs
Image upload does not use position and parent link property

 I am sending the request as shown below from the documentation, but for some reason, both x and y in the response are returned as 0.I am not sure if this is a bug or an intended behavior. requestcurl --request POST \ --url https://api.miro.com/v2/boards/board_id/images \ --header 'accept: application/json' \ --header 'authorization: Bearer xxxxxx' \ --header 'content-type: multipart/form-data' \ --form x=1000 \ --form y=1000 \ --form resource='@img1.png' response{ "id": "xxxxxxxxxxxx", "type": "image", "data": { "imageUrl": "https://api.miro.com/v2/boards/board_id/resources/images/xxxxx?format=preview&redirect=false" }, "geometry": { "width": 1024, "height": 1024 }, "position": { "x": 0, "y": 0, "origin": "center", "relativeTo": "canvas_center" }, "links": { "self": "https://api.miro.com/v2/boards/board_id/images/xxxxxxxxxxxxx" }, "createdAt": "2024-06-19T10:37:26Z", "createdBy": { "id": "xxxxxxxxxxxxxxx", "type

20011
Mettin
Mironeer
N
Nikhil SachdevaBeginner
posted in Developer platform and APIs
Getting 204 (no content) while attaching tag to a sticky note

I’m trying to attach tag to a sticky item using https://developers.miro.com/reference/attach-tag-to-itemAll IDs are correct, but the API throws 204 no content and the tag does not get attached. Kindly help

11311
William Bishop
Mironeer
Markus Smet
Markus SmetMiro Hero
posted in Developer platform and APIs
My experience of developing a Miro app

We have just finished a plugin for Miro that allows a user to “syncronise” widget content. Change one widget in a sync group and the change is propagated across all widgets in that group. The app is called CarbonCopy and we hope to see it on the Marketplace soon. Here’s a loom for you to get a preview.Here’s a summary of our encountered challenges.identified workarounds and challenges in MiroMissing widget update capabilities when widget changes: https://community.miro.com/developer-platform-forum-57/identify-changes-in-miro-widget-2845 Image meta-data updates aren’t working, which means we were unable to implement image widgets: https://community.miro.com/developer-platform-forum-57/image-widget-doesn-t-allow-metadata-update-2894 Buttons in the WidgetContextMenu iframe implementation cause slightly laggy widget performance when the widget has a plugin button in the widget’s extension menu. Setting the button position in the WidgetContextMenu is based on setting a numerical priority wh

105911
Max Harper
C
Chris MarquesNew Here
asked in Developer platform and APIs
Mindmap meets spreadsheet

Hi Everyone,   I really enjoy using Miro, although there is one thing that I do often and rather than using various apps would love to do within Miro. everything starts with a mindmap for me, but early on in the process I need to run basic simulations and would love the ability to use a cell within a shape as spreadsheet cell ( ie be able to enter basic formulas to then see the impact on the whole project of funnel )   For a simple example    top node has a title and a cell which is a variable ( eg invoice amount in ) a few child nodes have each a title and a cell which i assign a formula ( show 15% of top node here ) finally child node with resulting profit   etc   is this doable ?

159111
Anthony Roux
Mironeer
S
Sergey VorozhtsovBeginner
posted in Developer platform and APIs
Batch endpoints

Hi all.My case is - we render complex diagram with 1600 objects one the same board and other employees have read access. The board should be updated in some interval - every hour, for example.My first issue - posting. I post all those 1k+ object one by one which is slow and not efficient from CPU POV for both sides - miro and my app side.  Maybe miro developers can provide batch endpoint to accept list of objects?Next issue - recreating diagram, I can’t push only changes to the board, because logic would be super complex, because I’ll have to recalculate size of all elements, so it’s much easier for me to delete all and post everything again. My question is - How do I clean up the board with API? There is no such api right? I have to fetch all items by GET https://api.miro.com/v2/boards/{board_id}/itemsand then delete them ONE BY ONE withDELETE https://api.miro.com/v2/boards/{board_id}/items/{item_id}Is that correct? That’s ridiculous isn’t it?There should be batch endpoint for these o

14411
Josip Janzic
Mironeer
O
OlehContributor
asked in Developer platform and APIs
I don't see my app on a toolbar

Unexpectedly I don’t have my app on a toolbar. I had it but now I don’t. I don’t understand why( I have already tried all teams and boards and even different browsers but still can’t find my app.And I see here https://miro.com/app/settings/team/3458764611114804267/apps-and-integrationsthat the app is installed. Can anyone help me, please ?

12111
O
L
Leonard ThillmannBeginner
posted in Developer platform and APIs
SVG App Icon turns black

Hi there,I am trying to upload an app icon that is not black filled but has just the outlines. But when I import my svg, it always turns black even if reviewing the file, it isnt.Is there any way to just delete the outline icon?How can I solve this problem? Cheers, Leonard :)Original: What miro does to it:  What it looks like on the board:  

19711
Mettin
Mironeer
K
KJoBeginner
posted in Developer platform and APIs
Twitter Integration

It would absolutely transformative for me if I was able to paste Twitter links into Miro and have them appear as tweets. There's just so much information available on Twitter, yet I have to take screenshots to represent it. Maybe not critical to others, but this is critical to me. If Miro isn't able to undertake this development, I would be most grateful for some contact details for developers that might be able to undertake this (paid) work for me. Thanks!

42011
D
H
HFRNew Here
posted in Developer platform and APIs
Alphabetize Sticky Notes?

Is there a way to alphabetize sticky notes? It would be incredibly helpful to be able to group/organize them in this way, especially for dates and times.

45311
William Bishop
Mironeer
R
richardwBeginner
posted in Developer platform and APIs
User's LastActivity datetime from API

Hi,   Is it possible to get a member or non-team member’s LastActivity datetime from the API?   If not is it one the roadmap and is there a scheduled release date?   many thanks

112211
H
Christophe GESCHÉ
Christophe GESCHÉExperienced Community Member
posted in Developer platform and APIs
why did you choose such a complicated paging operation ?

 I understand the need to force a pagination (although 100; it's still a bit low.)But then the stroke of the cursor, I do not understand.Could a simple "offset" have been suitable?Limit=100&offset=0, Limit=100&offset=100, Limit=100&offset=200, … In any case, it complicates my work terribly.Maybe making access difficult and complicated is a way to reduce the load on api servers.

12910
Mira Balani
Mironeer
K
KalimuthuZluriBeginner
asked in Developer platform and APIs
Enable enterprise scope on developer app

Hello Team,I have an old developer App that is used by multiple users. Now, I want to enable additional scopes in the app, but the scopes are not getting enabled.These are the steps I'm following: I click on scopes to add, then click install app. It says it's successfully installed and returns with an access token, but I refresh the page to confirm and it's actually not added.I would really appreciate any help fixing this as soon as possible.   

11410
C
Mironeer
Terms & Conditions