Skip to main content

Developer platform and APIs

Discuss everything related to Miro API, SDK, embedding and Miro Platform apps development. See documentation at <a href="https://developers.miro.com/docs">developers.miro.com</a>

  • 986 Topics
  • 3,115 Replies
986 Topics
Robin Vessey
Robin Vessey
posted in Developer platform and APIs
API Widget lineEndType returning lineType values

Hello, I’m trying to get a list of all widgets, (cards and lines).https://developers.miro.com/reference#get-board-widgets-1Its mostly going well except I’m getting lineEndType = “orthogonal”     {  "id" : "3074457352100423348",      "startWidget" : {        "id" : "3074457352100422622"      },      "endWidget" : {        "id" : "3074457352100423021"      },      "style" : {        "borderColor" : "#000000",        "borderStyle" : "normal",        "borderWidth" : 2.0,        "lineEndType" : "orthogonal",        "lineStartType" : "none",        "lineType" : "orthogonal"      },      "type" : "line"}When the documentation says I should be getting one of:"none", "opaque_block", "rhombus", "opaque_rhombus", "circle","opaque_circle", "block", "open_arrow", "opaque_arrow" 

3081
farbodsaraf
Mironeer
3 years ago
T
Thomas LarssonBeginner
posted in Developer platform and APIs
Looking for a way to export Miro data (postit, frames, text) to Google Sheet

Export to CSV is quite poor and I cant sort from that data. I could go through API:s but I thought I ask first if anyone had done that?Small map that I use. 

5453
T
4 years ago
M
mulinPNew Here
asked in Developer platform and APIs
Autoincreasing Team Size with API

Hello everybody, i send invitation via API to new member and get error with message: 'User limit exceeded'. It all because there is 0 seats remaining, but when sending invitation from browser, it allows to expand team seats.Is there any possible way to send invitation via API with auto-increasing team size?

3461
Daniela Gavidia
Mironeer
4 years ago
R
RamkumarBeginner
posted in Developer platform and APIs
Bug Report: Line widget style update impacts bounds/endPosition properties

Hi, When we update Line widgets style through web plugin API, it impacts the read-only bounds/endPosition properties. This cause line widget to switch to undesired position when connecting between 2 widgets. Video for this behaviorhttps://www.loom.com/share/dbadddf3261a49388a28803725f81fa5Notice that the line changes position after color change Before and after comparison of widget properties 

4533
Esteban Beltran
Mironeer
4 years ago
J
Jesse HouwingBeginner
posted in Developer platform and APIs
Update internal board links after duplicate/import

We use a bunch of boards as templates and my colluagues have gone wild with links within a board.When I duplicate a board or when I import it as a backup, all of those links still point to the original board.I tried editing the backup file and making the link `?movetoWidget=283917482397498324`, whicn in theory should work, but the app prepends `http://` and claims the link is invalid.I tried the API, but many oobjects that can contain links can't be updated. Even ones that are documented, like `shape`.My code: $goodboardId = "o9J_xxxxx"$badBoardId = "o9J_yyyyy"$goodBoard = "https://miro.com/app/board/o9J_xxxxx#61;"$badboard = "https://miro.com/app/board/o9J_yyyyyyy&amp;#61;"$boardUri = "https://api.miro.com/v1/boards/$goodboardId"$headers = @{ Authorization  = 'Bearer XXXXXXX'}$supportedTypes = @("Sticker", "Shape", "Text", "Line", "Card")$widgets = Invoke-RestMethod -Uri "$boardUri/widgets/" -Method GET -Headers $headers$widgets.data | ?{ $_.text } | %{    $originalText = $_.text    

12456
J
4 years ago
N
niklaslavrellBeginner
asked in Developer platform and APIs
Play embed widget with the SDK?

Hi Miro,It is possible to play (i.e. click the play icon) the embed widget pragmatically with the web-plugin JS SDK? If no, it would be a wish list feature for me 😊Cheers,Niklas

3901
farbodsaraf
Mironeer
4 years ago
M
mxvrhubNew Here
posted in Developer platform and APIs
SOS! I lost access to the board I was developing. Free trial.

I would like to report a problem with access to the board I was using/developing.Somehow, the owner of the board is someone I don’t know. I don’t know that person and I don’t understand how it’s possible, that my content is not under my name. It’s a mess.Probably, this person had an empty board and I started creating my mind map there… I did not realize that was not the way to do it. I still don’t understand what just happened. I NEVER chose or agreed to follow the other boards either. I have no idea how and why they appeared on my list/dashboard. I have been trying to leave them, but there’s no such option. I want to leave all the boards except for one — that I have been working on for months. I currently technically cannot execute an upgrade for my account and I depend on the information that I have on my board. PLEASE, HELP! ASAP  Thank you!

5283
mlanders
4 years ago
E
Equator BytesBeginner
asked in Developer platform and APIs
Image widget doesn't allow metadata update

As per the documentation Image widgets metadata is not specified to be Read-only, but the miro.board.widgets.update method doesn’t update the metadata. At the same time it does allow the Title/URL properties to be updated.Documentation: https://developers.miro.com/docs/interface-iimagewidgetIs this a limitation of Image widget or is it a bug?

5071
Daniela Gavidia
Mironeer
4 years ago
M
Maximo ZarzaNew Here
asked in Developer platform and APIs
Embed board into own site authenticating by access token

Hi!I’m trying to embed Miro’s board into our platform but we need to abstract about Miro’s session for each user.It’s posible to manage access tokens for team’s users from API and then embed the board by param, so the user has not to login into Miro manually before render the protected board within iframe. Thanks in advance.

5641
Boris Borodyansky
Mironeer
4 years ago
N
NewBeginner
asked in Developer platform and APIs
Move an object up or down in layers - API

Forgive me if something is not entirely clear, I am a Russian-speaking user.I want to know how can I implement a method to move an object up or down in layers?It's quite easy to do it on the board - just select an object, press the ellipsis - brintg to front or Sent to back.How can this be done through the API?Unfortunately I am not at all familiar with API Miro, but I have experience in this area, so I think I can get an authentication token and connect to my board. What's next?Can you provide links to the required documentation? (I work in Python)Thanks.

15831
Daniela Gavidia
Mironeer
4 years ago
N
NewBeginner
asked in Developer platform and APIs
API Miro for your personal board.

Hello! I was versed in the API by following this documentation:I was able to build my development team and my floating decal board. However, I noticed that you cannot go to your main profile (which I work on) and connect the API to it. In the settings of your profile, when creating your application, you can select only the team profile, but you cannot choose your own.What does it mean? Can't I use the API on my board?

4491
Daniela Gavidia
Mironeer
4 years ago
E
Equator BytesBeginner
asked in Developer platform and APIs
Identify changes in Miro Widget

Hello,We would like to identify when an widgets(text/image) is updated and based on that we want to perform some actions. Currently there is no event type to indicate if the widget is being updated (We are not interested in WIDGETS_TRANSFORMATION_UPDATED which fires the position/size changes)Supported EventType: "SELECTION_UPDATED" | "WIDGETS_CREATED" | "WIDGETS_DELETED" | "WIDGETS_TRANSFORMATION_UPDATED" | "ESC_PRESSED" | "ALL_WIDGETS_LOADED" | "COMMENT_CREATED" | "CANVAS_CLICKED" | "DATA_BROADCASTED" | "RUNTIME_STATE_UPDATED" | "METADATA_CHANGED" | "ONLINE_USERS_CHANGED"As a workaround we thought we could use the SELECTION_UPDATED event to trigger the action after widget updated but then there is no modified timestamp against the widget to detect if any changes happened. Is there any workaround or hack to approach this problem?

3531
Kenneth Chen
4 years ago
Sami Ljimari
Sami LjimariActive Contributor
asked in Developer platform and APIs
de-select widgets

Hi I was looking for a solution to de-select currently selected widgets on the whiteboard here https://developers.miro.com/docs/interface-iboardwidgetscommands but couldn’t find a solution. I’m using a widget attribute of clientVisible: false . After I overwrtite a widget with this attribute it becomes invisible on the whiteboard but still can be manipulated with as it stays selected hence even while in clientVisible : false state the user is able to move it around, I would like to perform a de-select method after the clientVisible change, so that the user would either have to make the widget visible again to move it around or not be able to move it while it is invisible

4132
Sami Ljimari
4 years ago
M
Markus EdenhauserBeginner
posted in Developer platform and APIs
SDK Improvements on deprecation warnings

Hi,Not sure in which forum to put it.I just checked miro.d.ts for IBoardViewportCommands which I am using as single source of turth, but not all methods are listed there. Just fiddled in the console and on miro.board.viewport I get those methods listed:miro.board.viewport.  methodsWhen using the methods getZoom, zoomToObject it shows deprecation warning, alltough this methods are also listed on the documentation example here https://developers.miro.com/docs/how-to-start. Would be cool to see in the console which method to use instead (eg. getZoom shows deprecated, but could mention to use getScale instead).And a general migration section in the docu would be cool.Markus

3991
Daniela Gavidia
Mironeer
4 years ago
O
olivermcpheelyBeginner
asked in Developer platform and APIs
Access to Organisations endpoint (WRT creating daypasses)

Hello, My client is hoping to create / remove miro users via spreadsheet. In order to acheive this, they need to create occasional users (day passes). I am aware that occasional users are company level accounts, however I do not see company level endpoints mentioned in the docs. I noticed that the webapp achieves this by making requests to the following endpoint: /api/v1/organizations/{organisationId}/members Although my calls to the same endpoint are returning 404’s. Consequently, my assumption is that this endpoint is not available for public consumption. Am I correct, and if so do you have any plans to open this up in the future?   Thanks in advance, Oliver McPheely.

29624
Matthias.Cullmann
4 years ago
Ben Mort
Ben MortBeginner
posted in Developer platform and APIs
Why do updates though the REST API trigger a "connection restored" message when viewing the board in a browser?

I am in the process of updating and testing an app which updates boards though the REST API. While doing this I’ve noticed a change in behaviour from the last time this app was used. Making a call to the ‘update widget’ (https://developers.miro.com/reference#update-board-widgets) endpoint results in a “connection restored” pop-up in a browser watching the board being updated. This behaviour is also reproduced using the ‘Try-it’ button in the API documentation, and has been seen with both Firefox and Chrome.This is a issue as it results in the board becoming temporarily unresponsive. This change appears to have happened in the last 3 months as it was working well the last time the app in question was tested.Any help or advice on how to fix or work around this behaviour would be greatly appreciated.If you would like more details please let me know.

5302
Ben Mort
4 years ago
S
SathiaBeginner
asked in Developer platform and APIs
Export to Image - API

Is any other option available for export the board in format of image using miro API?

7371
Daniela Gavidia
Mironeer
4 years ago
J
jrgarlickNew Here
asked in Developer platform and APIs
Error trying to create Development Team

I am working for a larger organization which has Domain SSO enabled for their users. We are working on building a custom app for Miro, but when I follow the instructions on the Getting Started page, and click the Get Dev Team to Create an App, I get an error that says: “Domain users are not allowed to create any accounts outside of their domain organization.” We have been building the tool in our own development project, but it’s now time to hand it over to the company and I don’t see how to add it in their organization’s settings. Our ‘API, SDK &amp; Embed’ tab looks very different from theirs.Any help would be greatly appreciated.

4291
Robert Johnson
4 years ago
P
Pierre JannezBeginner
asked in Developer platform and APIs
How to add a template to frame with the API ?

Dear, I would like to set up a board with frames, one of them filled with a Kanban template. Did someone has done this before ? Thanks in advance for your help. Cheers Pierre

487312
R
4 years ago
Yash
YashContributor
asked in Developer platform and APIs
Linking to inboard object using SDK

Hey guys, Miro is awesome, and to learn more awsomeness of miro I have been playing with miro SDK. I know how to create widgets like card, stickers, lines etc. I want to link one widget, lets say sticker A to some other shape in the same board. Visually, we can do this by selecting sticker A, then “ctrl + k” and selecting the target shape in the board. But I cant figure out how to do this using SDK. PS:- One alternative is to wrap the text of sticker A inside &lt;a href="link to the board object here”&gt;TEXT&lt;/a&gt;. But this makes the text a hyperlink, not exactly what I want to accomplish.  

32835
M
4 years ago
Sami Ljimari
Sami LjimariActive Contributor
asked in Developer platform and APIs
Detect when a miro board widgets gets created and deleted

Is there a integrated miro command or any other way to detect when a miro widget gets created on a board? And even more importantly can we access it’s id and other data immediately as it gets created? The only solution to this that comes to my mind is to gather all current miro board widget id’s and compare them in certain time intervals against new widget id’s whenever the time interval triggers. This solution seems really dirty and inefficient to me though so I’m trying to ask here first to find out if I could theoretically implement some sort of a event listener for miro widget creation

4921
Daniela Gavidia
Mironeer
4 years ago
Sami Ljimari
Sami LjimariActive Contributor
asked in Developer platform and APIs
How to correctly use bringForward() and sendBackward() Miro board functions

Hi, I’m trying to use bringForward() and sendBackward() Miro board functions which I found here: https://github.com/miroapp/app-examples/blob/master/miro.d.ts (line 351 - 357) I assumed this only needs the widget id’s in an array but when I tried with some test data it doesn’t actually change the widget “priority” AKA doesn’t send them forward or backwards. Tried something like this: `sendbackward(arrayOfWidgets)` where arrayOFWidgets were a few selected widgets from current boardIs there a specific use case that has to be done like with miro.board.commands , where they have to be in a miro on ready block? Or am I missing something else?  Thanks for any suggestions

9232
Sami Ljimari
4 years ago
M
Maximilian PopraweBeginner
asked in Developer platform and APIs
Settings for a web-plugin

Hi all!How do I set up my plugin to have settings on the Apps&amp;Integrations page? I would like to give the user some configuration options.Alternatively, I guess this can be done with a modal view (to configure) and a hidden widget (to store). Is that a good approach? Are there better ways to let the user configure a plugin?Thanks for your help :)   

4842
M
4 years ago
M
Morgan WallNew Here
posted in Developer platform and APIs
Card Due Dates pulling wrong

Has anyone else experienced an issue where the due date on your card does not match the “date” field when pulled from Miro?  This is happening in about 50% of the cards I am pulling and for all of them the incorrect date is one day ahead of the correct assigned date.  eg. if the due date is “Nov. 12” the output json from a Python Requests API pull will say “Nov. 13”.   I have not noticed any correlation with when the cards were created or modified.  

4611
Daniela Gavidia
Mironeer
4 years ago
D
Danny HolyoakeNew Here
asked in Developer platform and APIs
Using REST API to change User's Role causes System Error

Heya,I am trying to use the REST API to automatically deprovision our users when a member leaves the team.I am using the Update Team User Connection endpoint to change a member’s role from ‘member’ to ‘non_team’. I’m doing this because it’s the best way to ensure a member’s boards aren’t deleted when their account is removed.When I try this with an account, I get a 500 error, both via Postman and the API reference page, with the message InternalError.After this happens, the user can no longer access the Team Boards at all. The web interface’s Users list still lists them as a Full member, and presumably they are still licensed as such.When using the API, the user is no longer listed under List All Team Members, and the Team User Connection ID will 404.Is this a bug that I'm running into, or am I doing something wrong here? Is there a better practice to deprovision users?Thanks for any help you can provide!

4331
Daniela Gavidia
Mironeer
4 years ago
Terms & Conditions