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>

  • 932 Topics
  • 2,980 Replies
932 Topics
T
TimPBeginner
posted in Developer platform and APIs
BoardPicker integration issue

Hello, I have submitted the form with an integration request several days ago, but still having “integration is unavailable”. Should I wait for email from miro or what is the ETA on this process?

5
William Bishop
Mironeer
2 years ago
M
Michael SanniNew Here
posted in Developer platform and APIs
Not receiving webhook events for comments

I noticed Miro not sending webhook events for comment but send notifications for other property change like stick_notes, text, shapes etc, is this a known issue and are there progress to fix it or how can we get comments events from the webhook ?

5
William Bishop
Mironeer
1 year ago
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:

5
Anthony Roux
Mironeer
1 year ago
Mira Balani
Mironeer
Mira BalaniMironeer
posted in Developer platform and APIs
Miro REST API introduces flowchart shapes

Good day Miro developers! 🖖 😃 In our endeavor to extend our features and functionalities, the experimental release of shapes now supports flowchart shapes in addition to the basic shapes that we support in production. This experimental release supports read operations for flowchart shapes via the following APIs:Get shape item (experimental) Get items on board (experimental) Get specific item on board (experimental)For more information, see the changelog. Cheers,Mira

5
William Bishop
Mironeer
1 year ago
Daniil Gavshin
Daniil GavshinBeginner
posted in Developer platform and APIs
How to get mockup's information via the API?

I have a simple ‘Wireframe’ element and I want to retrieve “test placeholder” string from this input via the API request.Example request:curl --request GET \ --url 'https://api.miro.com/v2/boards/BOARD_ID/items?limit=10' \ --header 'accept: application/json' \ --header 'authorization: Bearer API_TOKEN'And response:{ "size": 1, "limit": 10, "total": 1, "data": [ { "id": "ITEM_ID", "type": "mockup", "links": { "self": "https://api.miro.com/v2/boards/BOARD_ID/items/ITEM_ID" }, "createdAt": "2022-10-21T17:58:26Z", "createdBy": { "id": "USER_ID", "type": "user" }, "geometry": { "width": 507.5290985795079, "height": 101.50581971590158 }, "isSupported": false, "modifiedAt": "2022-10-21T18:05:45Z", "modifiedBy": { "id": "USER_ID", "type": "user" }, "position": { "x": -153.48916664925795, "y": 590.8997696991773, "origin": "center",

5
William Bishop
Mironeer
1 year ago
P
Pavlo HolovkoBeginner
asked in Developer platform and APIs
Image upload does not use position and parent link property

Hello Currently I am using this API request to upload a file from devise to an mirro boad.Create image item using file from device - https://api.miro.com/v2/boards/{board_id}/imagesBut I have notice in response that passed parameters from forma-data is not applied to the image that was uploaded recently. But everything is working fine if use image link not a file to upload to boad.Is it a bug or feature?)

5
M
2 months ago
P
paulgNew Here
posted in Developer platform and APIs
Miro SDK - Connector event listeners

Hi,I want to know if event listeners are available on connector events (creation, deletion and modifications. i.e. a user modified a connector connecting elements A and B to connect elements A and C) on a miro board. I am looking at the documetnation and the only relevant thing I can find is this:experimental:items:updateWhich says: Currently, experimental:items:update fires only when items are moved on the board, when an item dimensions are resized, when an item is rotated on the board, and when updating the scale of an item. In the future, the event will also fire when updating other item data.I read this as saying that connectors are not currently supported.Is this correct or am I missing something in the documentation?Thanks in advance

5
K
8 days ago
Matthias.Cullmann
Matthias.CullmannContributor
posted in Developer platform and APIs
PATCH //miro.com/api/v1/scim/Users userName not unique

Trying to update an existing user as of https://developers.miro.com/docs/users#update-user-attribute-by-idIf the taget userName belongs to a deleted account, I get …{  "schemas" : [ "urn:ietf:params:scim:api:messages:2.0:Error" ],  "status" : "400",  "scimType" : "invalidValue",  "detail" : "User name '*******@baloise.com' is invalid: 'not unique'"} You can reproduce this with the user ID 3074457348934407798. The UPN can not be changed to the baloise.com email domain. Expected behaviour: a deleted account does not count as duplicate and it is possible to reuse UPN’s of deleted accounts.

5
Matthias.Cullmann
2 years ago
B
Bob ButlerNew Here
posted in Developer platform and APIs
Migrating to the "Developer Platform 2.0"

I was sent an email that states “Since you have one or more apps on the v1 Developer Platform, we encourage you to migrate your app as soon as possible” but as far as I know I am not using any v1 API (except https://api.miro.com/v1/oauth-token) so I do not understand what is meant.I do not use any SDK, just raw API calls.  The documentation is not at all clear so I’d appreciate any clarification on how I can determine if I do still have anything on the v1 platform.

5
Robert Johnson
2 months ago
B
Brad MclainNew Here
posted in Developer platform and APIs
504 Gateway Timeout

Trying to use the smartsheets within the MIRO board and numerous users reporting the same issue with 504 Gateway Timeout  

5
T
1 year ago
A
AlexeiBeginner
posted in Developer platform and APIs
REST API update geometry errors

Hi, I’m having problems changing the geometry of a card.e.g. (from python)payload = { 'geometry':{'width':260, 'height':130}}url = f"https://api.miro.com/v2/boards/uXjVPdveOFo=/cards/3458764531765310379"response = requests.patch(url, json=payload, headers=headers).json()results in {'type': 'error', 'code': '3.0215', 'context': {'boardId': 'uXjVPdveOFo=', 'itemId': '3458764531765310379', 'validationErrors': [{'code': '3.0211', 'message': 'Value for width should be greater than or equal to 256.0, found: 147.39173256538714'}]}, 'message': 'Unable to complete operation because of the validation errors.', 'status': 400} which doesn’t make sense as the width I’m setting is &gt; 256. It seems if the card has been manually resized at some point, the API call will either get ignored (response returns the size set, but item on canvas does not change) or it returns a nonsensical error.Is this a bug in the API?

5
A
2 years ago
E
Eduardo CastellanoBeginner
posted in Developer platform and APIs
Is there a limit to the number of items selected for a Custom Action?

Dear Miro Team,I am implementing a mini application with the Custom Action of the web sdk 2.0.The user selects a series of items from the board (app_card, card, connector, frame, shape, sticky_note and text) and when clicking on the button in the context menu a calculation is executed (my custom action).Everything works correctly, but I have observed that when I select more than 50 items, my application does not appear in the context menu. I've looked in the documentation but I don't see anything about a maximum limit on the selection.Is there any type of limitation?This is how I have defined my custom-action: ....export async function init() { await miro.board.ui.on("custom:calculate", actionHandler()); const calculateCustomAction: CustomAction = { scope: "local", event: "calculate", ui: { label: { en: "Calculate", }, icon: "chat-plus", description: { en: "Sum of estimated points", }, position: 1, }, predicate: { $or: [

5
Mettin
Mironeer
3 months ago
S
Stephen WingertBeginner
posted in Developer platform and APIs
data-classification Rest API (internal server error)

I am using the REST API call...https://api.miro.com/v2/orgs/{org_id}/teams/{team_id}/boards/{board_id}/data-classificationI am getting valid responses back from the call, but the vast majority of the time I am getting the following error returned even though the board has a classification label.{  "code": "internalError",  "message": "Internal server error",  "status": 500,  "type": "error"}Thanks for the support!

5
William Bishop
Mironeer
1 year ago
J
Juan MendozaBeginner
posted in Developer platform and APIs
Creating a menu and then calling API from every option

Hi, I’m new using this framework, but all I need is a guide to create a menu with many option to call an API.Thanks in advance,

5
Horea Porutiu
Mironeer
5 months ago
V
VeeraBeginner
posted in Developer platform and APIs
cannot subscribe

HelloI cannot subscribe to a subscription because the postal code does not work. I am sure it is 100% correct. Please revise your fill-in form for errors.

5
Mettin
Mironeer
2 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

5
Mettin
Mironeer
1 month ago
S
Samartha KhareBeginner
asked in Developer platform and APIs
Regarding miro board integration (Urgent Help Required!!)

Hii teamI have created a react and embedded the miro board in it with some shapes but I can not edit those shapes. ( I am using a free account) Also if I purchase the paid version can I make:Do edits on canvas Use AI generation feature Remove the “Developer Team” water mark 

5
Horea Porutiu
Mironeer
18 days ago
A
Anton ShherbininContributor
posted in Developer platform and APIs
Bug: When the user application panel closes, an unplanned widget selection occurs.

Hello!Select the widget on the board -&gt; open the user application panel -&gt; close the user panel -&gt; remove the selection from the widget. Now if you open the panel again and close it again, the widget will stand out by itself. Moreover, even if the widget is removed, then after closing the panel, dots will fall into the selection (which should not already be on the board).This bug is definitely not because of my code, because I created an absolutely empty application (below I will give the code that I wrote). This bug appears in my other apps as well.miro.board.ui.on("icon:click", async () =&gt; { await miro.board.ui.openPanel({url: 'proba.html'});});For clarity, I present a video from a file sharing site (it will be available for 6 days).link 

5
Mettin
Mironeer
10 months ago
K
Ksana SerkovaNew Here
posted in Developer platform and APIs
Plans

 Hello!I need some help with plans. Is it possible to create teams if I have a Starter plan? Or teams are available only fo business plans?Thank you in advance!Best wishes,Oksana

5
Marco Spinello
Mironeer
1 year ago
C
Carlos LópezBeginner
posted in Developer platform and APIs
Did Miro update the way permissions work? Getting a Insufficient permissions error with out code change

Had configured our app to create boards from other boards (by copying them), and suddenly it stop workingThis is our flow, we call : "https://api.miro.com/v1/oauth/token?grant_type=authorization_code"Then we call:url = URI("https://api.miro.com/v2/boards?copy_from=#{template_id}")And we are getting this error"Full body {\"type\"=&gt;\"error\", \"code\"=&gt;\"4.0602\", \"context\"=&gt;{\"boardId\"=&gt;\"xxxxx=\"}, \"message\"=&gt;\"Insufficient permissions to perform operation. Please check the permissions or contact support\", \"status\"=&gt;403}"Permissions have not been changed in monthsApp has permissions to read / write and original board has view permissions for every one, this error started appearing jus a few weeks ago.

5
M
1 year ago
ronny
ronnyContributor
posted in Developer platform and APIs
IDEA: Add hidden markers to widget

We create widgets via the Miro API and query them afterwards back. We need to know which widgets are what (e.g. to find stickers placed within a specific widget). So far, we rely on the text to match the enclosing widget. Yet, this leads to issues if users change the text in the Miro UI and it’s cumbersome if boards are localized (i.e. lots of text variants to match). (Aa an alternative, we considered storing the Miro widget ID but that’s tricky as it requires us to hold this state.) We would like to send a hidden marker to the API during widget creation, which is then returned when querying for widgets. As a parallel, consider the ID field in HTML elements: The developer sets it, website users don’t see it and can’t change it, yet developers can query the elements afterwards with this ID via `getElementById`.

4
Anthony Roux
Mironeer
2 years ago
Falk Kühnel
Falk KühnelActive Contributor
posted in Developer platform and APIs
CANVAS_CLICKED event

Hi!   I was using the CANVAS_Clicked event to place objects with the x and y attribute of the event. Now these have disappeared and i have not found out how to use the new event info how to place an item right at the click point on the canvas. Can anyone help?   Thanks Falk

4
Falk Kühnel
4 years ago
A
Alex.hrNew Here
asked in Developer platform and APIs
Integration with notion

Poor integration with notion. Mind maps do not update when I make changes, some do not appear at all. Attached photo number 1 and 2 this is how it looks in your website, photo number 3 how it looks in notion  

4
M
4 years ago
Falk Kühnel
Falk KühnelActive Contributor
asked in Developer platform and APIs
Can we add custom Items in Plugins like cards or specifically rendered items?

Hi!   I would like to be able to add items, that have a certain functionality and would need a special rendering, like having dice represented on the board or playingcards, that can be flipped, or an avatar with a hands up indicator. Is there a way to do that? The normal API options do not allow for something like this.   Thanks Falk

4
Kiron Bondale
4 years ago
acyment
acymentBeginner
posted in Developer platform and APIs
Is it possible to block certain actions on images? (e.g. rotation)

Hi  there! I’m developing an uber-simplified Sim-City-like simulation to use on a training setting. I’d like to know if there is a way to block actions like scaling or rotation on images.   Thanks! Alan

4
mlanders
4 years ago
Terms & Conditions