Community FAQs
Product News
Groups
Events

Join the Miro Talktrack Challenge and enter for a chance to win 🏆

14 days ago

Home
Community overview
Questions & Ideas
Developer platform and APIs

Developer platform and APIs

Discuss everything related to Miro API, SDK, embedding and Miro Platform apps development. See documentation at developers.miro.com

770 Topics
2,514 Replies

When you subscribe we will email you when there is a new topic in this category

770 Topics

Recently active

Most replies Most views Newest first

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.

2 years ago

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.

2 years ago

SathiaBeginner

asked in Developer platform and APIs

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 <a href="link to the board object here”>TEXT</a>. But this makes the text a hyperlink, not exactly what I want to accomplish.

2 years ago

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

2 years ago

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

2 years ago

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&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 :)

2 years ago

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.

2 years ago

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!

2 years ago

Kenya SuzukiNew Here

asked in Developer platform and APIs

How to set getToken response

Hi there, I want to use Embed miro board.So, I implements frontend plugin referring below.https://developers.miro.com/docs/editable-boards-for-anonymous-users Then, I have a question.When we use miroBoardsPicker.open, what kind of values should be passed to getToken property?In the document, they say only we should generate jwt in server side.I want to knouw actual type of the property. Regards,

2 years ago

MohsenBeginner

asked in Developer platform and APIs

The METADATA_CHANGED event does not call back.

The METADATA_CHANGED event is still experimental, and it does not call the call back in my browser. How can I subscribe to it? having it is really useful.

2 years ago

Sami LjimariActive Contributor

asked in Developer platform and APIs

Get user id

Hi,I have tried a few ways to get the current user id, but I always encounter a error in one way or another. What is the most basic way to get a user id? So far I have mainly tried this: async function getUser() { const proxyurl = "https://cors-anywhere.herokuapp.com/" // getting cors error without this const url = "https://api.miro.com/v1/users/me" const options = { "method": "GET", "headers": { “Authorization”: `Bearer ${token}`, "Content-Type": "application/json" } } fetch(proxyurl + url, options) .then(response => { console.log(response) }) .catch(err => { console.error(err) }) }I’m currently getting error 401 “Not Authorized”I’ve seen a few discussions in here about a direct miro dot command that can get the user id but can’t find it anywhere in the documentation. Will be thankful for any suggestions as I ran out of ideas of what to

2 years ago

Jeff CarnahanBeginner

asked in Developer platform and APIs

Guest T&C Acceptance

Is there a way to have a T&C pop up for guests to accept before they can view/interact with a board?

2 years ago

Sami LjimariActive Contributor

asked in Developer platform and APIs

Is it possible to use window.location.pathname to get Miro board path while using REST API?

Hi,I’m using Miro REST API in the form of a sidebar, I’m trying to export data to a external database and would like to mark each dataset with its corresponding miro board ID from the board url like this one for example: https://miro. com/app/board/hereistheboardid/I’m trying to do this by calling window.location.pathname.split('/') from which I then obtain an array of paths in the link. Unfortunately the paths that I get returned back are ones from my server where I keep the code to my miro REST API Outlined in blue is my sidebar, from which the url path gets returned, but in the red there is underlined the actual window url / location which I believe it should return. Any ideas how to get the miro board URL via my REST API / webplugin?

2 years ago

CSABeginner

asked in Developer platform and APIs

Edit web-plugin after install

I’m new to creating plugin for Miro. I have created a test plugin by follwing https://developers.miro.com/docs/how-to-start this & successfully added to my board. But how to modify/change my plugin after installation. When I change the code in index.js file of my web page which is hosted in the web plugin url, the plugin does not affect. It keeps un changed. How to update my plugin to affect changes.Thank you

2 years ago

Andrei JNew Here

posted in Developer platform and APIs

Detect changes using the sdk

I am writing a plugin that detects changes in a board (widget created, deleted, etc), and I want to take a screenshot of the change.The plugin can detect those changes, but I am stuck at the screenshot part. I have tried to integrate an iframe in the plugin but with no success. I want to ask you what ideas would you suggest?

2 years ago

Craig HardcastleBeginner

asked in Developer platform and APIs

Plugin widgets.get() by id doesn't seem to work

Hi, I am trying to get widgets by id using the await miro.board.widgets.get({ id }) but it doesn’t appear to work? I have tried single ids, array of ids, both with strings and integers and nothing comes back? Is that expected behaviour? This is within the onReady callback; Thanks, Craig

2 years ago

Bob S

asked in Developer platform and APIs

How to start building

Hi guys,I want to code a simple calculator to use inside the Miro environment.Since I am completely new to doing this in Miro: Do I need to build this functionality within my own HTML environment and embed this piece of code within Miro using something like an iframe? I can’t figure out if it’s always a ‘web plugin’ you’ll have to load from your own website/environment.If someone can explain me where to start, thanks a lot!All the best,Bob

2 years ago

Craig HardcastleBeginner

posted in Developer platform and APIs

Plugin widget.create() promise never complete

Hi, I seem to be having an issue in getting the miro.board.widgets.create() promise to complete. The widgets are created but the returned promise never changes from “pending”. I have tried creating widgets one at a time and in batches but with no luck. As I say the widgets do create but without the promise completing or even erroring there is no way for my code to complete… it just hangs forever :( Anyone else has this issue? My code block is wrapped in the miro.onReady() callback so I don’t think i need to do anything else? Thanks.

2 years ago

JeremyJBeginner

posted in Developer platform and APIs

Bug with embed iframe

2 years ago

Sami LjimariActive Contributor

asked in Developer platform and APIs

Is there a miro board command to gather all widgets?

What is the best way to get a list of all widgets on miro whiteboard. I would want something like “miro.board.widgets.get.all”. Used this for reference https://developers.miro.com/reference#get-board-widgets-1 Edit: deleted the original question, this ^ was pretty much it

2 years ago

Sami LjimariActive Contributor

posted in Developer platform and APIs

Get miro board object

Hi, I would like to get a Object of the whole, complete miro board. Found this article in documentation: https://developers.miro.com/reference#get-board But it doesn’t include any miro board command that can be used like with board widgets for instance which have something like this: miro.board.widgets.get()tried miro.board.get() but the feedback I get from console is that it is not a supported function, so the question would be if there is any integrated way of getting the whole board as an JSON object for the sake of “replicating” / “duplicating” the board contents on a new board for instance. Also, how should I go on about getting custom board objects like images to get them on a new board since I would like to get the exact copy of a already existing board which may include .jpg (or similar) files on it. Alternatively is there a different / better way to do a task like this? Thanks for any suggestions

2 years ago

Sami LjimariActive Contributor

asked in Developer platform and APIs

How to implement miro.board.widgets.get() or .create()?

Hi,Sorry if this is a trivial question or is at some point answered in the documentation. But I have been trying multiple ways of implementing these 2 methods and none seem to work right now. I’m trying to use this functionality in a miro board extension, the biggest problem is that my implementation worked on last friday, but when I tried to follow up on monday, I have this error every time: Uncaught TypeError: Cannot read property 'widgets' of undefinedMy attempts to use these methods:1)let allWidgets = miro.board.widgets.get()2)let AllWidgetsOnBoard = Promise.resolve(miro.board.widgets.get({ "type" : "SHAPE" })) //returns all widgets on board with shape type AllWidgetsOnBoard.then(function(v) { console.log("AllWidgetsOnBoard: ", AllWidgetsOnBoard) })3)let allWidgets = miro.board.widgets.get().then(function() { console.log("widgets on board: ", allWidgets) }) console.log("widgets on board: ", allWidgets)4) return miro.board.widgets.create({

2 years ago

Page 28 / 31

Terms & Conditions

Sign up

Already have an account? Login

Log in to the community

Enter your username or e-mail address. We'll send you an e-mail with instructions to reset your password.

Username or e-mail

Back to overview

Scanning file for viruses.

Sorry, we're still checking this file's contents to make sure it's safe to download. Please try again in a few minutes.

This file cannot be downloaded

Sorry, our virus scanner detected that this file isn't safe to download.