Skip to main content

Developer platform and APIs

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

  • 1,035 Topics
  • 3,259 Replies
1033 Topics
M
Mario MeurisNew Here
posted in Developer platform and APIs
Image update via the SDK ?

On the miro board when an image widget is selected a control bar pops up with the option to update. Is that functionality available via the SDK ?

372
M
M
Manoj Sharma_DevNew Here
posted in Developer platform and APIs
How To embed Board

How do I embed Miro board into web application that is not mine i want to integrate miro board into noysi can somone pls Help 

311
Robert Johnson
A
Ayaka YamadaBeginner
asked in Developer platform and APIs
How can I use current Miro board which I used or create after graduate?

Hello team!I am heavy user of Miro (Education plan given by school) ! I create a lots of notes, files even CV, and I would like to keep using / editing the file after graduation.However school’s email account will expire after graduate. I shared all the file with private gmail account just be safe (free plan). But I am not sure, what will happen after my main school account expired.Is there anyone know how can I keep using? How should I avoid loosing all my files? Thanks!

656
A
S
Sebastian HeblerBeginner
posted in Developer platform and APIs
REST API: How to put images on a board?

Hi, I’m trying to put a image to a Miro board via the REST API (https://developers.miro.com/reference/create-image-item-using-file-from-device). I tried different variants of the code below. Error ranging from 400 to 415.          headers = {'Authorization': 'Bearer <token>',                   'Content-type': 'multipart/form-data',                   'Accept': 'application/json'}        json_data_as_json = {            "title": "title for the image",            "position": {                "x": 100,                "y": 200,                "origin": "center"            },            "geometry": {                "width": 100,                "height": 100,                "rotation": 0            }        }        response = requests.request("POST", url, json=json_data_as_json,                                    data={'resource': base64.b64encode(open('c:/temp/test.png', 'rb').read())},                                    headers=headers,                                    verify=False

1470
S
A
Alberto GirettiBeginner
posted in Developer platform and APIs
Miro app panel doesn't show up

Good morning everyoneI am developing v2 version of Kobi application which uses both web-idk and REST API. Many times in an unpredictable way the click that opens the app panel, in the left vertical bar, does not work. The console reports this error.4vendorSentry~applica.core~auth.8b07d16f64431856.js:1 Error: Cannot update the app, because the corresponding client ID 3458764528362411636 wasn't found.    at e.destroyIframeController (cmn~BoardSdk.380163e792da4247.js:1:285600)    at l (cmn~BoardSdk.380163e792da4247.js:1:245504)    at a.execute (VM12:70:174269)    at s.dispatch (VM12:70:176429)    at e.destroyPrevScope (cmn~BoardUI.desktop~BoardUI.mobile~BoardUI.webview.c82f802eef76553b.js:1:538073)    at e.compileContent (cmn~BoardUI.desktop~BoardUI.mobile~BoardUI.webview.c82f802eef76553b.js:1:537236)    at e.setScope (cmn~BoardUI.desktop~BoardUI.mobile~BoardUI.webview.c82f802eef76553b.js:1:535958)    at controller (cmn~BoardUI.desktop~BoardUI.mobile~BoardUI.webview.c82f802eef76553b.js:1:

1885
Anthony Roux
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
A
Alfredo FenoglioBeginner
posted in Developer platform and APIs
How to get Jira Card details with SDK 2.0

I’m trying to get the details (custom fields) of a Jira card but I can’t manage to get any of the custom fields. Jira card:I tried with the API and JS and both methods are getting the basic information but not the custom fields.With API: https://api.miro.com/v2/boards/xxxxxxx/cards/345yyyyyyy { "id": "yyyyyy", "type": "card", "links": { "self": "https://api.miro.com/v2/boards/xxxxx/cards/yyyyyy" }, "parent": { "links": { "self": "https://api.miro.com/v2/boards/xxxxx/items/zzzzzz" }, "id": "zzzzzz" }, "createdAt": "2022-12-19T13:42:19Z", "createdBy": { "id": "uuuuuuuuuuu", "type": "user" }, "data": { "description": "This is the descriptio", "title": "Test Jira Incident" }, "geometry": { "width": 342.323283997474, "height": 158 }, "modifiedAt": "2022-12-19T14:56:44Z", "modifiedBy": { "id": "uuuuuuuuuuuuuuu", "type": "user" }, "position": { "x": 185.64376445455173, "y": 366.9530191265535, "origin": "center", "relativeTo

1332
A
A
Anton ShherbininContributor
posted in Developer platform and APIs
Event when pressing a button on the keyboard

Hello!Is it possible to assign an event to any button on the keyboard in Miro? I am trying to use the following code:alert("1");document.addEventListener('keydown', funсKey);function funсKey() { alert("2");}The first alert displays "1", but the second one does not work when you press the button on the keyboard. I tried to do this by replacing "keydown" with "click", but it didn't work either.

501
William Bishop
Mironeer
Markus Smet
Markus SmetMiro Hero
asked in Developer platform and APIs
Is it possible to capture the CardID and Title props. of a Jira card in Miro?

Is it possible to capture properties of a Jira Card on a Miro board? I am wondering if the Jira card extends a Card Widget which means Jira Cards can be called via the SDK’s read method?

4802
A
A
AliakseiVilNew Here
posted in Developer platform and APIs
Miro API: Create Kanban Item

Hi, I’m trying to create a Kanban item but no success. Is it possible in current API version? I’m trying to send my payload to `https://api.miro.com/v2/boards/:board-id/kanbans` but no success.

1622
Robert Johnson
F
Frankie HadwickNew Here
posted in Developer platform and APIs
Export XMI from UML class diagram

Im looking to see if there is a Miro plugin or native support from exporting a UML class diagram from Miro to an XMI file? If not does anyone know a way of achieving this? 

3391
Max Harper
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.

191413
Boris Borodyansky
Mironeer
K
Kaur KuutBeginner
posted in Developer platform and APIs
Event for sticker text change

I am talking about the Miro web plugin SDK and its capabilities.There are multiple events that I’ve successfully used in relation to stickers.WIDGETS_CREATED - Successfully fires when I create a new sticker. WIDGETS_DELETED - Successfully fires when I delete an existing sticker. WIDGETS_TRANSFORMATION_UPDATED - Successfully fires when I resize a sticker.However there does not seem to be any event that fires when I change the sticker text. This is especially annoying because this also applies for the very first edit. So when I create a new sticker, I get the WIDGETS_CREATED event for this sticker. However after I write some text for this sticker, there will be no event. It’s only later, for example when I resize the sticker, that I will catch on to the fact that the text has changed.Is there an event I can subscribe to that fires when the sticker text is changed? Did I miss something?If there isn’t any such event right now, are there plans on adding such an event? Knowing when the user

16910
William Bishop
Mironeer
J
John HotterbeekxNew Here
posted in Developer platform and APIs
Need help capturing paste event in SDK2

Hi,We are working on a miro plugin, using SDK 2, for an integration with one of our systems. When pasting a url from that system on the miro board I’d like to capture that event and create a card instead of just pasting the link. I’ve searched everywhere I can think of, but I’m not able to figure out how to capture this event? Although I see other plugins do the same thing (e.g. the Jira plugin). Is there any documentation for this? Or has anyone figure out a way to do this and is willing to share this solution? Thanks!

553
J
T
Takeshi MizumotoBeginner
posted in Developer platform and APIs
Rest API: operationNotSupported occurs to update connector object when it is not connected

Hello, I am trying to update connector color, but it fails if it is not connected to the card.Using the Miro API document https://developers.miro.com/reference/update-connector, I executed the following command to change the connector color to the red.echo '{"style":{"strokeColor":"#FF0000"}}' |  \  http PATCH https://api.miro.com/v2/boards/board_id/connectors/connector_id \  accept:application/json \  authorization:'Bearer HIDDEN' \  content-type:application/jsonThis request works if both the two teminals of the connector is attached to the cards.  However, if at least one terminal is not connected, it returns the following error:{ "type": "error", "code": "operationNotSupported", "message": "Operation not supported", "status": 400} Is there any workaround to fix this?

552
T
P
Pavel LiubinskiNew Here
posted in Developer platform and APIs
Bug: the connector content not displayed

Hi, I think I discovered a bug, very straightforward GIVEN I’m accessing miro board via HTTP API V2WHEN I create 2 shapesAND I create then a connector between them with a captionTHEN the connector is created but the caption is not visible on the board, instead a small gap on the line is visible Please see the screenshot  Below is the request sequence - 2 shapes are created and the connector between themPOST https://api.miro.com/v2/boards/uXjVPGrkY4Q=/shapes {  "data": { "content": "shape1", "shape": "rectangle"},  "position": { "x": 380, "y": 220 }}// for example the returned ID of the shape is 3458764538045266088POST https://api.miro.com/v2/boards/uXjVPGrkY4Q=/shapes {  "data": { "content": "shape2", "shape": "rectangle"},  "position": { "x": 610, "y": 220 }}// for example the returned ID of the shape is 3458764538045266457POST https://api.miro.com/v2/boards/uXjVPGrkY4Q=/connectors {  "startItem": { "id": "3458764538045266088" },  "endItem": { "id": "3458764538045266457" },  "captions

623
William Bishop
Mironeer
William Bishop
Mironeer
William BishopMironeer
posted in Developer platform and APIs
Announcing the public beta of Webhooks!

Miro Developer Changelog EntryHey, everyone!Over the last few months, we’ve been hard at work building out the beta of a much anticipated capability, webhooks. Today, we’re excited to open this up for public beta, and we can’t wait to see how you all leverage webhooks to extend the power of the Miro Developer Platform. 🚀 In this initial iteration and beta period, webhooks support the update, creation, and deletion of board items.  It’s really important to us that we can create the best possible developer experience when it comes to this new capability, so please share any and all of your feedback with us here in the thread below, or in the #public-betas channel on our Discord server!Important: Please keep in mind that this is an early beta, so you should not implement or rely on this capability in any kind of production environment, as there may be changes, bugs, etc. We’ll be sharing all feedback directly with our Product and Engineering teams to ensure we’re creating the best versio

1580
William Bishop
Mironeer
D
Daniel CaveNew Here
asked in Developer platform and APIs
Is using Miro inside a secure website with unregistered users possible?

I make secure websites for virtual events which users must login to to use. Multiple clients are asking if we can but a whiteboard on a page, something like jamboard, Mural, Miro etc.. so they can do a brain storming session or whatever. I can do this with Miro embed easily… Just embed it and make it publicly accesiable to anyone with the link. Winner.However; If someone got that embed code, copied it and posted it elsewhere, in theory ANYONE could join. Normally that’s such a small concern id ignore it, however my clients are security conscious in the extreme. So i would have to use the enterprise account to domain lock where the iframe will show. which again is fine, if expensive for what I need.So i was wondering (other than the above enterprise ‘domain locking’ option) is there anyone who knows if I can embed the whiteboard in a way that will let users logged into my the site access the board without them having to login or create miro accounts.The reason I dont want them to have t

2483
J
S
Sk Nur HasanNew Here
asked in Developer platform and APIs
Capture miro board without using miro UI

Hi,I am trying to capture miro board without loosing any data field but  the challenge is I want to do this  without using Miro UI(from backed api call or if there is any other way).please help me to find out this solution and let me know if that can be done from backend or frontend(but without using miro) ?

371
Marco Spinello
Mironeer
mscottfowler
mscottfowlerBeginner
posted in Developer platform and APIs
Miro Board Organization

It would be very helpful to have a multi-level folder structure in the left navigation or dashboard (probably better), so I could organize all my glut of Miro boards into different sections.

901
Robert Johnson
Daniel Fosco
Mironeer
Daniel FoscoMironeer
posted in Developer platform and APIs
Miro Developer Platform – Open call for user research

Hey everyone 👋I'm a UX Designer working on the Platform team at Miro, and we're running a round of user research for our development workflow.We are planning to conduct 45-minute interviews between November and December 2022. Everyone who participates in the interview will be compensated with a $50 gift-card for their time. If you're interested, please fill out the form below and we might be in touch. Thank you!https://forms.gle/44R8TcTp5RDTgDeR8  EDIT: The form is now closed, thank you everyone who submitted a response! We’ll be in touch soon 😄

430
Daniel Fosco
Mironeer
A
Anish AnsariNew Here
posted in Developer platform and APIs
Convert Mindmap to a json file REST API

We are developing an App where we want our users to use miro and create a mindmap and once they’re done we want to export that in json file without lossing the structure.For example: There is an user who wants to create a certain course on our platform so we give the user to mindmap everything they want and later we can use that mind map to structure a course for the user.Is this possible? if yes, how? I want to use the REST API to read the structure of mindmap. Actually I want to do the following.List MindMaps Convert mind map structure to json file. Thanks

6633
Addison Schultz
Mironeer
J
jantonsoNew Here
posted in Developer platform and APIs
Does Miro oAuth API support Basic Auth for passing client credentials?

Hi,For Step 3: Exchange authorization code with access token of the Miro OAuth 2.0 authorization flow, does the https://api.miro.com/v1/oauth/token API endpoint support passing the client_id and client_secret values via Basic Auth? We’re currently passing them through via the request body as x-www-form-urlencoded parameters, but would prefer to update it to use the “Authorization: Basic xyzxyzxyz” header instead! I’ve tried to do so using my Insomnia client to generate a POST request to the https://api.miro.com/v1/oauth/token endpoint with grant_type, code, and redirect_uri passed in the body and client_id and client_secret base64 encoded and passed via the Basic Auth header, but am receiving this 500 error in response:  Is this possible? Thanks,Josh

791
William Bishop
Mironeer
L
lesleyNew Here
posted in Developer platform and APIs
Use Boards Picker satisfied App security guidelines requirement?

Hi, I’m a product management planning to embed Miro board in our website via Boards Picker.I have read your App security guidelines and I’m confused about the requirement：Use OAuth 2.0 authorization.if we use Boards Picker，it seems that we don’t Use OAuth 2.0 authorization，can we publish our app to the Miro Marketplace？I’m looking forward to hear your answer.

362
L
K
Katie CullumNew Here
posted in Developer platform and APIs
I can't see edited comments

Hi I wonder if you can help me. I couldn’t see edited comments only highlights. I came off the board and went back to it as I thought maybe that would solve the issue. Now I can’t see anything. I’m on the free plan but I thought others invited would be able to edit and you would see these.

372
Robert Johnson
Terms & Conditions