Skip to main content

Developer platform and APIs

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

  • 1,135 Topics
  • 3,455 Replies
1135 Topics
A
ArnauNew Here
posted in Developer platform and APIs
npx create-miro-app fails

npx create-miro-app@latest crashes with the following error: Unexpected error. Report it as a bug, so we can look into it:                        TypeError: t.replaceAll is not a function It doesn't depends on the options I choose, it fails all the time. I am using Node version 14.21.1 and NPM version 6.14.17 on Ubuntu 22. I tried different create-miro-app versions and 1.8.0 is the most recent that works.

974
Mettin
Mironeer
V
Victor64100New Here
posted in Developer platform and APIs
Iframe background,modyfing

Hi ,With this code i cant set a background ,<iframe src="https://app.databox.com/datawall/e8c95f383a6cf2d526f95b28487bc5d" width="1280" height="720" frameborder="0"></iframe><style>body{  background-image: url('https://i.goopics.net/kxekcg.jpg');  background-repeat: no-repeat;  background-size: cover;}</style> Someone already find out something or miro is just not friendly with iframe background ?  My goal is to replace the image that Miro gives when you put an iframe code .  Thanks .  

1282
Marco Spinello
Mironeer
M
MJ PetroniBeginner
posted in Developer platform and APIs
bug(ish): creating a card widget using Zapier asks for a hex color, but requires # and that is not documented

Hi there. Was dumbfounded for a while when setting up an airtable → miro card widget Zap in zapier. Setting card color is possible, but requires the hex color code to have a preceding #. That’s fine, but it’s not documented in an easily-accessible way outside of the API docs and not all apps require it. The Miro docs are a bit obtuse for non-developer pro users, and the error returned via zapier was just ‘method argument.’ Searching for that in the API docs didn’t lead me anywhere. Digging around and reading carefully, noticed the need for #, but I recommend making more verbose error codes or being clear about data validation requirements somehow. 400-Bad Request did not make it clear. Thanks for considering.  

261
Mira Balani
Mironeer
C
CigeyoBeginner
asked in Developer platform and APIs
Do we need to have paid account to keep oAuth app?

Hi, We developed an oAuth integration and other miro users already using it. We want switch to free account, but we are not sure our oAuth app integration will be still available in the app market. Some platforms could remove free accounts after some time.

421
William Bishop
Mironeer
Carola Wenk
Carola WenkBeginner
posted in Developer platform and APIs
Use Rest API to get a list of board member names (in project) ?

Hello. I am the owner of a team (on an education account) and would like to list the *names* of the people who have created or modified items on one of my boards in my team.Setup: The board is inside a project (= folder), I am the board owner, and three other users are part of the project and therefore have access to the board and have edited it.Problem 1: The Rest API v2 only lists items with user IDs (not names anymore, as it did in v1). I need the names for those users.Problem 2 (potential bug): Rest API v2 user-connections query is supposed to return all board members, but it only lists myself, not the other three users who have access to the board and have already edited it. Shouldn't they also be board members?Problem 3: It looks like with an education account I don't have access to the “list team members” functionality. Any ideas? I have the user IDs of my team members and I need to map them to names.

26910
Carola Wenk
V
vp_appgamiBeginner
posted in Developer platform and APIs
Serious regression with API v1

Hi there,Some time ago we have found a regression on the SDK v1 that is blocking the usage of our Miro extension "Smart Diagrams". The extension essentially provides a list of pre-built Miro diagrams that can be added to your board, saving time when creating nice-looking boards.However, since a couple of months ago, when users choose a diagram to add to the board it gets added normally, but then if they resize it, all shapes are transformed into squares! This breaks the whole user experience and it's a blocker for users to continue using our extension. Here's a video showing the problem:  I've been in touch with some people from Miro, who confirmed that they could reproduce the problem, but I've never heard back nor this has been fixed. So I'm hoping that the community can help and hopefully the Miro folks can get back to us.Does anyone else have this issue as well? Miro, please help! We are stuck!Thank you. P.S: we tried moving to the SDK v2 but there are many missing forms and attrib

913
V
E
EranNew Here
posted in Developer platform and APIs
Get installed user applications via API

Is it possible to get installed user applications via the RestAPI?I want to be able to list all app tokens for each of my organization users.

191
William Bishop
Mironeer
D
Dave SkuraNew Here
posted in Developer platform and APIs
rest api to read content of stencil

Hello, I want to read the ERD template to produce a DDL, but can’t figure out how to read text/content from stencil type.  can anyone help ? thx,Dave

873
Mira Balani
Mironeer
Wiktor Zurawik
Wiktor ZurawikNew Here
posted in Developer platform and APIs
Miro REST API endpoint does not return all card data

Hello all!I’m playing around with Miro’s API and I encountered one issue that may be a bug (or not, fingers crossed :)). I created a board on which I placed a couple of cards. Each card has a title, me assigned to it and due dates set.I query the https://api.miro.com/v2/boards/{board_id}/cards/{item_id} endpoint but it does not seem to return the full data on specified cards. Within the data field I get the assigneeId, description and title properties but dueDate is always missing. So essentially from this:I get that: Is someone familiar with the issue? I may be missing something here. 🤔Cheers!Wiktor

1968
B
S
saraTomBeginner
posted in Developer platform and APIs
App Integration -- name value pair/tabular data

I have a use case where users would create handoff sheets in Miro. So they might add a section that contains some form data field name/value pair.Name  XXXX Company YYYY      I understand the tabular data cannot be pulled via App integration..  What is the best way for the user to enter a name/value pair so that the Rest API can pull the data? I would like to see if there is an elegant way for users to input the data and ihe API can map the name-value pairs.

341
Max Harper
P
PeiliNew Here
posted in Developer platform and APIs
Regression Boards Picker

Since this morning the Miro Picker doesn’t work anymore:picker.248f8f1cbcc61993.js:2 Failed to execute 'postMessage' on 'DOMWindow': The target origin provided ('https://www.company.url') does not match the recipient window's origin ('https://miro.com').

443
William Bishop
Mironeer
B
Bill GallagherBeginner
posted in Developer platform and APIs
How to find the age or validity of an access_ or refresh_token

I’m looking for how to find the age or time left on a token. I can call https://api.miro.com/v1/oauth-token with the access_token in the header as a Bearer token. Works great, tells me it’s "type" : "oAuthToken" and other info, but it doesn’t tell me how long I might have left on it. I’d also like to know whether a given token is a refresh token, but when I use the same pattern as above with the refresh_token in the header as a Bearer token, it doesn’t work. I get that it shouldn’t because refresh!=access, but is there any way to get more info about a refresh token? The other option is to always refresh and not care how much time is left, but that feels excessive. While you’re here, can anyone tell me the difference between the /oauth-token and /oauth/token paths?Thanks all! 

822
B
R
Richard121212Beginner
asked in Developer platform and APIs
REST API how to handle boards with more then 1000 widgets?

HiWe have a board which is bigger then 1000 widgets. The List Widget (https://developers.miro.com/reference#get-board-widgets-1) has a limit of 1000. We tried the option to use the filteroption and get only the FRAMES and then load all the children by the https://developers.miro.com/reference#get-board-widget But.. (as expected) we get the   "message" : "Request rate limit exceed",   We can put more time for calling the 1000+ times on the webservice, but that does not seem ideally. But maybe there is an other way? As an idea… Is it possible to add a REST service, which can get multiple Widgets by multiple ids?  So as a parameter a list of Ids to get from the boar? Best regards,

144421
Marco Spinello
Mironeer
C
Chris EigensonneNew Here
posted in Developer platform and APIs
Error code API connect to Torii

Hello, since 2 days we are getting an error if we are trying to connect Miro to Torii to automatically manage Users and licensesError: Failed to request authorization for application 3074457365632507822 in team 3458764516327583199 Can you pls let us know how to solve that issue=?thanks Chris 

512
C
J
Joseph LowBeginner
posted in Developer platform and APIs
How to make a sidebar plugin, rather than a pop-up plugin

Hey all, I’m working on developing a Miro plugin and would like to find out how I can make my plugin take up the sidebar, rather than opening up as a pop-up. I’ve attached a screenshot of the difference between the sidebar and pop-up plugins which I am referring to (Let me know if there is a correct way to name these!). The documentation only has openPanel and openModal which do not work for me. Any help would be much appreciated!  Cheers!  BoardUI DocumentationSidebar PluginPop-up Plugin 

26112
N
J
Justin FenechBeginner
asked in Developer platform and APIs
Custom menu on Widget Bar

Forgive me for using incorrect terminology as I have just started digging into this.I understand how to add a custom icon to the widget menu bar and am able to show a modal, however I would like to instead make my icon display a “dropdown-like” menu instead. Much like the functionality of the tags or assignee dropdowns. Is this possible?Thanks,Justin

15264
T
ronny
ronnyContributor
posted in Developer platform and APIs
OpenAPI/swagger file to auto generate SDK

  Do you have a OpenAPI/swagger file for the Miro REST API? We want to auto generate a SDK for TypeScript/NodeJS SDK. In case you don’t have this, we saw this Typescript definition file on your Github: https://github.com/miroapp/app-examples/blob/master/miro.d.ts - Is the idea that we copy this for our usage (better: can we link it somehow, so we get updates when you adjust it)? Many thanks!

15793
Thomas Vanier
V
Victoria ReworldNew Here
posted in Developer platform and APIs
How to connect Miro with iinkJS, a handwriting to text recognition plugin?

https://github.com/MyScript/iinkJS How do we add this handwriting to text recognition as a component into Miro? For mind mapping users like myself, it’s best practice to write/draw your own mindmaps to retain information, but I would also like a format that’s easy to read and neat, having iinkJS from myscipt as a form of input would be great. Plus i searched online, there is no other app that does this besides Nebo themselves, but they lack a lot of features. How to integrate this, if someone wanna guide me, I can even write this, i will even pay. Thanks for reading.

6452
B
Adam Mashburn
Adam MashburnBeginner
posted in Developer platform and APIs
Why is there a massive "Developer team" watermark on my board?

Several of my boards have a MASSIVE watermark with the team name in the background. Makes it unusable its so stupidly huge. How do i make it go away and why is it there in the first place?

284921
B
Daniel Fosco
Mironeer
Daniel FoscoMironeer
posted in Developer platform and APIs
Announcing App Manifests

Hey everyone, I'm Daniel, product designer with the Miro Platform team. We're happy to announce our new platform feature App Manifests is now available in beta!  The app manifest is a YAML file that describes all the settings of your app. It enables you to quickly edit settings and replicate configuration between apps—with more capabilities coming soon. This is an optional feature that does not affect the existing settings page: you can keep using it normally, and any setting changes will be reflected between the UI and manifest. Also, all of our app examples on Github have been updated with app-manifest.yaml files, so it's even easier to get started with one of them! Check out the video below for more details of how it works, or just head to your app settings and click "Edit in Manifest". This feature is available to all Miro customers with a developer team. Feel free to share your feedback and thoughts about this feature: what works for you, what doesn't, and what else would you like

850
Daniel Fosco
Mironeer
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  

3045
T
T
Tyler SanbornBeginner
posted in Developer platform and APIs
504 on app authorization

Hello, I followed the steps here, and am trying to install the app to my dev board but getting a 504 timeout every time. I was able to solve an earlier auth issue with the trailing slash on the Redirect URI, but I’m stuck here. .env file is all updated too. Thank you for any guidance in advance!Interstitial to install appDev app URLsApp settings 

1739
William Bishop
Mironeer
H
hamsters-leanix-smp
posted in Developer platform and APIs
OAuth asking for enterprise scopes from enterprise teams without having enterprise accounts

I would like to ask, if it is possible to have an OAuth application, that request the Enterprise scopes from the people / teams having the Enterprise plans, without having the Enterprise account myself?Based on the answers in Don't see organizations:read scope in Oauth app and How to add see the scopes of the Dev account on the enterprise acount , I am aware that I can not access this endpoints on my account (since we do not have Enterprise) and do do not provide the sandbox for this. But I don’t need this two.All I would like is request these scopes from the people that have the enterprise plans.If this is not possible, what is your recommendation for the alternative? Make each one create the app in their own teams? Or is there any easier solution for this?

977
William Bishop
Mironeer
S
saraTomBeginner
posted in Developer platform and APIs
Call External Rest API from Miro SDK

I need to create a custom plugin to integrate Miro with my internal application. The app would push the data from Miro to the internal application. Is there any recommendation to call an external API hosted by an internal application that requires OAuth authentication?

1511
Mira Balani
Mironeer
D
Daniel VidonyiNew Here
posted in Developer platform and APIs
Is there an API to upload a whole Miro board in one atomic operation, instead of constructing it with multiple API calls?

I have flowchart-like diagrams made by an other diagramming suite, and I would like to convert and upload them to Miro.Currently the only way I see this being possible with the Miro Rest API, if I build some adaptor that sends an API request for each item and connector. (e.g.: create board, create item a, create item b, create connector,… etc..) This will result in lots of API calls even for a simple diagram, with lots of networks calls and error scenarios to manage, possibly with transactions needed.Is there an API that would allow me to assemble the Miro diagram on my end and somehow upload it to Miro in one atomic operation with only a few API calls involved? (e.g: upload the whole thing described in one json?) Do you have any other recommendation on how to handle the use case?  

1101
Josip Janzic
Mironeer
Terms & Conditions