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
J
jirimoarichiBeginner
asked in Developer platform and APIs
Group object is not persisted after element was deleted in UI

Hi, i come from my another question where i added items to existing group. But i encountered not expected behaviour when fetching selected group. What i do:Select group of items and run my code (see bellow):   Delete one item from this group via UI Select this group again. I can see, that counter of the items updated in UI Then i run my code wich triggers onClick()(thanks to @Mettin ):   export async function checkGroupItems() { let selectedElements = await miro.board.getSelection(); if (selectedElements) { let group = await miro.board.getById(selectedElements[0].groupId); console.log(group); }}   And i still get that deleted item in group.items   Is this a bug or is it my code caches group in somewhere? I call my function from app.jsx&lt;div className="cs1 ce12"&gt; &lt;a onClick={(event) =&gt; checkGroupItems()} className="button button-primary" &gt; Check group items

994
Frederico Estrela Gaiva
3 months ago
Yong-Chong Long
Yong-Chong LongContributor
asked in Developer platform and APIs
Mirotone App Card design doesn't match, trying to mimic it

Mirotone.xyz has a AppCard component but it doesn’t match the design of an actual Card or App Card on a Miro board, here’s a comparison (Mirotone.xyz on the top and actual Card at the bottom):  We could sprinkle some CSS to mimic the look similar but I do hope the one on Mirotone can be updated to match instead, here’s some CSS I added in a quick attempt: .app-card { border-radius: 8px; border-width: 2px 2px 6px; padding: var(--space-small) var(--space-medium); .tag { background-color: transparent; border: 1px var(--indigo100) solid; }}  

511
William Bishop
Mironeer
3 months ago
K
kevterBeginner
posted in Developer platform and APIs
Update email address with Python and SCIM API

I’m trying to update a user email address but getting a 404 error when trying to patch with the SCIM API. I first get the user ID via REST API and use that to construct a payload with the PatchOp schema and replacing userName with a new value. Image with code attached for reference. Is this possible to do?We previously would just deactivate a user after a name change and transfer all boards to the new account, but that does not maintain access to previously shared boards. Having Miro support update the email address seems to keep those shared board permissions in place so was hoping that this API method would do the same. 

23814
Horea Porutiu
Mironeer
3 months ago
I
itassetmanagementNew Here
asked in Developer platform and APIs
Powershell script to export miro users

Hello Team,I would like to export all miro users from specific org and teams, I have the access token, but my current powershell script does not give me Email, Name and Status, only I can see binary value.Is there any way to do it?

651
William Bishop
Mironeer
3 months ago
D
DevIntegrationNew Here
asked in Developer platform and APIs
BoardPicker 1.0 stopped working

Hey,We have an integration with MIRO on our application using boardPicker 1.0. Recently after embedding the board from MIRO into the application we started to see the following screen:Was board picker deprecated? How can we fix the issue?

642
D
3 months ago
A
Andrew AlsdorfNew Here
asked in Developer platform and APIs
This there an API to return Access Requests

This there an API to return Access Requests

541
Horea Porutiu
Mironeer
3 months ago
E
Ernst van der HeijdenBeginner
asked in Developer platform and APIs
AnonymousUser

Hai, When a user has no access_token when using the api, my program generates an url and redirects to that url. At callback, the user is AnonymousUser. How does my program know what user I was before callback?Or do I have to handle the callback from within a frame or so?Thanks, Ernst

604
ElvaMiro
Mironeer
3 months ago
E
Ernst van der HeijdenBeginner
asked in Developer platform and APIs
Code for copy and change a board

Hai Elena,With the given code I am able to create a new board with a name.url = "https://api.miro.com/v2/boards"payload = { "name": "{doc_name}",  "description": "{doc_description}",}headers = {   "accept": "application/json",   "content-type": "application/json", "authorization": "Bearer {token}",}response = requests.post(url, json=payload, headers=headers)So far so good, but where can I find the commands and or code to copy an existing board and tochange an existing document. I know that I have to use ‘put’ to copy the board, but I can’t find out more.I have managed to assemble the above code from https://miroapp.github.io/api-clients/python/miro_api.html#MiroApi.api_client.Can you please help me out? If I get this all done I have need for 7-10 more licenses for many years to come. So good business I’d say.

634
E
3 months ago
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&amp;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

19011
Mettin
Mironeer
3 months ago
N
Naveen prakashBeginner
asked in Developer platform and APIs
API requests Query

Hi Teamhttps://api.miro.com/v2/boards?limit=50&amp;owner=(user1)&amp;createdBy=(user2) I need to filter the boards that are currently owned by user1 but were originally created by user2.I getting all boards owned by user1, not filtered where condition created by user2 in response. Thanks.

552
N
3 months ago
E
Ernst van der HeijdenBeginner
asked in Developer platform and APIs
Multiple shapes update

Hai there!Is there a possibility to update multiple shapes there content in one request.Shape 1 content=&lt;p&gt;abc&lt;/p&gt; update to &lt;p&gt;def&lt;/p&gt;Shape 2 content=&lt;p&gt;ghi&lt;/p&gt; update to &lt;p&gt;jkl&lt;/p&gt;Thanks

482
E
3 months ago
E
Ernst van der HeijdenBeginner
asked in Developer platform and APIs
Changing a shape via Api

One last question for now:What is the code for updating an items it’s content? I tried it with:url = f'https://api.miro.com/v2/boards/{board_id}/items/{item_id}'data = {"data": {"content": "&lt;p&gt;123&lt;/p&gt;"}}headers = { "accept": "application/json", "authorization": f"Bearer {access_token}",}response = requests.patch(url, json=data, headers=headers)Can you help me? And where can I find all the possibilities?

452
E
3 months ago
E
Ernst van der HeijdenBeginner
asked in Developer platform and APIs
Example code for Python (Django)

Hello, I’m new to Miro and I’m trying to use Auth2 to manipulate documents. But I can’t find out how to get de access_token with Python (Django) with or without miro_api. I created an app and have cliendid and secret. I created a return_path in my application.Does anyone have some example code for getting the access_token? Thanks in advance!

1164
ElvaMiro
Mironeer
4 months ago
T
tran.chungNew Here
posted in Developer platform and APIs
Don't see organizations:read scope in Oauth app

Can someone tell me how to create an Oauth app that requires organizations:read scope?Or how can I access to that scope? 

1467
A
Mironeer
4 months ago
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!

2746
Robert Johnson
4 months ago
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?   

836
Robert Johnson
4 months ago
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.

16588
Eca
Mironeer
4 months ago
C
Chandra Sekhar TBeginner
posted in Developer platform and APIs
how to create clickable button / shape in miro frame

Hi, we want to use Miro board for online course where on click of a button on a frame should execute script. May i know if this is possible in Miro i.e adding a clcikable event on a shape

13844
M
4 months ago
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!

672
Ben Mort
4 months ago
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

1095
Mettin
Mironeer
4 months ago
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?

641
Horea Porutiu
Mironeer
4 months ago
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? 

162825
A
4 months ago
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:

1554
N
4 months ago
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! 

731
ElvaMiro
Mironeer
4 months ago
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

1749
N
4 months ago
Terms & Conditions