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>

  • 987 Topics
  • 3,117 Replies
987 Topics
A
Aleksandr ChilikinContributor
posted in Developer platform and APIs
GET boards limit

API request https://api.miro.com/v2/boards gets 10000 boards but I have more (( How can i get ALL the boards?  

1459
Horea Porutiu
Mironeer
9 months ago
T
Thorsten DiekhofNew Here
posted in Developer platform and APIs
Is there a way to give guests access to my own app?

I've developed a small miro web-plugin.Anonymous guests should be able to use this app on my board.Is there any way I can do this? I have not found any information on this. Thanks very much, Thorsten Diekhof

1196
ElvaMiro
Mironeer
9 months ago
E
Eduardo CastellanoBeginner
asked in Developer platform and APIs
How to access the text of the tags inside the stickly notes or app cards?(Using Web SDK v2)

Greetings colleagues,In the past, I developed a small private application with the web sdk v1. It was very basic, I added the application in the context menu and when selecting a series of widgets (sticky notes, app cards, etc..) my application appeared in the context menu and in its inner workings what it did was to go through the selected widgets, search the tags inside them and add those that matched a specific numerical format.I want to migrate it to version 2 of the new sdk and the truth is, it is being quite difficult.I have read the documentation and I think that the closest thing to my needs is to make a CustomAction.I have been able to add my customAction to the context menu and show an information message when I click on it. I need to be able to read somehow the content of the tags, their text, but I can't find any way to do it. Is it possible to do it somehow? I share my code with you: import type { CustomAction, CustomEvent } from "@mirohq/websdk-types";const actionHandler

724
E
9 months ago
B
ba_tnoNew Here
posted in Developer platform and APIs
How to access link of an item through API?

I have a large board with 650 items, some of those items contain links (added via right click → "Edit Link”). How can I access these links via the REST API? I can get the item itself via the boards/{{board_id}}/shapes/{{item_id}  and that includes a "links” key, but that only has the link to the item itself, not the link added via "Edit Link”.Where is this data stored? How can I retrieve the added link for each item?

562
William Bishop
Mironeer
9 months ago
A
Aaron GallaherNew Here
asked in Developer platform and APIs
Use Web SDK to get all mind map nodes

I’m trying to get a list of all nodes in a mind map using the Web SDK.  The documentation here: https://developers.miro.com/docs/websdk-reference-mindmap-node gives the following example// Get all mind map nodes from the boardconst items = await miro.board.experimental.get({type: 'mindmap_node'});However, when I run it on my board, I only get the root node of the mind map.  Is this supposed to return all nodes?  Am I missing something?An alternative approach I’ve tried is to use the above to get the root, then use miro.board.experimental.get() to retrieve every child node by id recursively, but I always bump up against rate limiting.

301
William Bishop
Mironeer
9 months ago
C
Chris ProsserNew Here
posted in Developer platform and APIs
How to authenticate for fully automated rest API usage?

I am having trouble understanding how to authenticate my app to use the REST API with my specific use case. A high level overview of what I need my app to do is as follows:Read existing boards Compare items on the boards to data within a data warehouse Create board items to represent specific data in the data warehouse (if they don’t already exist)This would be executed by a script and run on a schedule, so no human user would be involved. What I am not understanding is Step 2 of the “Authorization flow for expiring tokens”: “Request user for authorization”. https://developers.miro.com/reference/request-user-for-authorizationHow does this work since there will be no user? Is there another way to receive an authorization code or a way to get an access token without one? I am a business analyst, not a developer, so explaining it like I’m five is much appreciated!Thanks in advance!

1443
Horea Porutiu
Mironeer
9 months ago
G
Gabor DaherNew Here
posted in Developer platform and APIs
Authorize Web SDK app on individual boards only

I have found this topic, but it’s 3 years old. Is there a way to enable a web sdk plugin to selected boards only?If an app is installed in a team, and a user has authorized it, then the app will be able to access any boards opened by the same user, which sounds like a security concern to me.Is my understanding correct? How to prevent this? Does the workaround of creating a team and installing the app only in that team still do the job, like mentioned in the linked question?Thanks!

121
C
Mironeer
9 months ago
T
Talat Varis
asked in Developer platform and APIs
Can´t manage user licence

Hey all,I want to manage the user license from each user through the API, unfortunately I can´t find a way or any information within the API site.Does anybody has a idea?https://developers.miro.com/reference#introductionBest Regards

5327
A
9 months ago
R
Roman ZinnatovNew Here
posted in Developer platform and APIs
App Card UI Customization using App Card CSS component

Hello! The docs says:“To provide a great experience for your users and meet app review requirements, we recommend using UI components from our interface library, Mirotone. We have an App card CSS component that you can use to represent Miro app cards in your interface.” Could you please point me to an example of how I can apply App Card CSS Component to my app cards. For example, I want to make custom layout of an app card, add checkboxes and buttons. Thank you!

390
R
9 months ago
E
echatzikyriakidisBeginner
asked in Developer platform and APIs
Hi to hide js code from custom web plugins?

Hi everyone! I am thinking to build a new web plugin to manage Miro board elements and I have found that this can be done with JS, specifically with NodeJS and ExpressJS. My question is how someone could "hide", secure the JavaScript source code of the web plugin as it can be easily inspected in the web browser with web developer tools. This is fine for open source systems but how to build it for a proprietary system so that the code is not visible? Does anyone have implemented a proprietary web plugin for Miro? Do I have to build a backend system, authorization, etc? Thanks 🙏

1078
Mettin
Mironeer
9 months ago
M
MikeymikeBeginner
posted in Developer platform and APIs
Export structure and information from objects on a miro board

My dream is to generate and manage a Miro design that perfectly reflects a data structure in eg a database or excel table.From the Miro Web SDK i learnt that it’s possible to generate a mind map in Miro based on a excel spreadsheet (csv). However if I make small adjustments in the mind map in Miro i would like my spreadsheet to update. In this way Miro would not only be merely a drawing and presentation tool, but the actual visual representation of a data structure. I’m not only thinking of mind maps here, but rather general sync of information from data source to Miro and vice versa.Is it possible to create this kind of functionality using the SDK?

5019
M
9 months ago
J
joeloBeginner
posted in Developer platform and APIs
Locally hosted Miro app not showing up in toolbar

I followed all the steps in this tutorial but couldn’t find the app in the More apps section of the toolbar. I tried running it on Chrome with all security features turned off. Any ideas?

1947
J
9 months ago
J
John DeauNew Here
asked in Developer platform and APIs
Sticky note is not created in local app

Hey guys,I created a local Miro app (at localhost:3000) where I have an Add a sticky button. If I press the button, nothing will happen. There are no errors in the browser console. I tried pasting this code to the console: await miro.board.createStickyNote({  content: ‘Hello, World!’,});but it wouldn’t do anything either.Am I missing something? 

341
Robert Johnson
9 months ago
Carla Sofia Teixeira
Mironeer
Carla Sofia TeixeiraMironeer
posted in Developer platform and APIs
[New] Say Hello to New Developer Benefits 🚀

Hey, Miro developers! 👋We’re thrilled to introduce Developer Benefits to your Miro app development experience. Building for the Miro Marketplace now comes with a variety of benefits, including free 1:1 consultations with technical and platform product specialists, access to free complimentary Miro Business plan account, and special promotion for your app for greater customer reach and recognition.With Developer Benefits, you automatically unlock all of these special benefits as you reach specific milestones — no enrolment needed.To learn more, check out our FAQ. Of course, if you have any feedback, or if there are different benefits you'd like to see added, just let us know!  Cheers,Miro Developer Platform Team

210
Carla Sofia Teixeira
Mironeer
9 months ago
A
Andreanne DroletNew Here
asked in Developer platform and APIs
board on app not loading

All board on app not loading but work in browser.

201
Robert Johnson
9 months ago
A
Andrea ScalabrinNew Here
posted in Developer platform and APIs
Unpredictable results from GetBoards REST API

Good afternoon,I am trying to call the REST API manually for testing purposes, but I noticed that I get unpredictable results. I currently have 3 boards. Board TEST 3 was just created moments ago.However, the API returns that there are only 2 boards available. I have run this directly on the documentation sandbox to make sure the problem wasn’t with my calls. I still get consistent results and the board TEST 3 is not present in the JSON response.All three boards have read/write permission with the Developer team that I created for this testing purpose, so they are accessible (or they should be). At some point and after trying the GET request several times, without changing anything with the boards (I think I’ll be waiting for something like a couple minutes), the third board will appear.Deleting a board seems to have an instantaneous change within the database, therefore if I call the API after deleting a board, it will disappear at the following API call. However, trying to re-add a b

240
A
9 months ago
G
Geir ØlnesBeginner
posted in Developer platform and APIs
Syntax for attaching metadata to a shape using API

HiI am trying to attach metadata to a shape widget created from javascript through the API.Widget is created correctly when there is no metadata, but creation fails as soon as metadata is part of the widget definition. I have interpreted the metadata definition from this post:https://community.miro.com/developer-platform-and-apis-57/how-to-attach-meta-data-via-webplugins-682and from the documentation here:https://developers.miro.com/reference/application-metadataThe result looks like this:    let shapeWidgets2 = await miro.board.widgets.create([        {            type: 'shape',            x: x3,            y: y3 + 150,            height: 30,            metadata: {                ['TEST']: {                    'type': 'sannsynlig',                },            },        },    ]) I have tried several combination with and without aphostrophes, but none of them works.Can anyone out there give me a hint on what is wrong with the code?

38215
A
Mironeer
10 months ago
V
Vincent NeveuxNew Here
posted in Developer platform and APIs
Extracting data (from several boards ) towards a single place

Hello !I've been using Miro for several years and many projects (30+). I love it, it's a great tool that really helps me thinking. But the downside is that, along the way, all my work has been stored on several different boards through various architectures.Lately, I've been wanting to grab all that "data" and to gather it in a singular place. I want it to be easier for me to cruise between my past projects, to centralise all their output. My goal is clarity and readability. The data in itself is mostly text but, as you can guess, with a precise visual organization also.By any chance, would any of you have an idea or a recommandation?I'm looking for a technique to "extract" the data, but also for a way to could store it visually in a convenient way.Thanks in advance, and have a great day :)

731
Elena Ignatik
Mironeer
10 months ago
G
Gerald DunnNew Here
asked in Developer platform and APIs
Deriving Structure Metadata from API Widget

If i use the API to query a widget on a Kanban board, I get an X and Y co-ordinate, but I don’t seem to see any reference to the structure of the board itself eg Swimlane/Bucket name or indeed the fact that the widget is contained within a particular swimlane/column. Am I missing something.  Is there some API call that allows me to further discover the structure and relationship between widgets?

18707
S
10 months ago
A
Allison KelseyBeginner
posted in Developer platform and APIs
Miro Trigger in Zapier

I would like to set up an automation between Miro and ProductPlan using Zapier. Trigger: Sticky added to a Miro boardAction: Add contents to ProductPlan roadmap parking lot Unfortunately Zapier informs that only Miro actions are available.

571
K
Mironeer
10 months ago
Daniel Fosco
Mironeer
Daniel FoscoMironeer
posted in Developer platform and APIs
Mirotone UI Changelog

This topic is the changelog for the Mirotone UI Library, the official design resource for Mirotone CSS. For feedback or questions, check the announcement post for the library, or leave a message on our Discord server. 📣 Subscribe to this post and get updates in your inbox whenever a new version is released 📣  Version 1.2 Initial release of the Mirotone UI Library: Adds Foundations Colors Functional Colors Typography Spacing Effects Spacing Radius   Adds Icons People icons Objects Symbols Board objects 16x16 icons 32x32 icons   Adds components App Panel App Card Inputs &amp; Checkboxes Select Buttons Divider Dismissible Badge Link Tags Tabs Table Tooltip   Adds Utilities Canvas utilities Installation flows  

1392
William Bishop
Mironeer
10 months ago
Anastasia Lebedeva
Anastasia LebedevaBeginner
posted in Developer platform and APIs
Interaction with cursors

How cool would it be if in Miro you could not only see the cursors of other participants, but also INTERACT WITH THEM? For example, a dear colleague or an inquisitive session participant is swimming next to you, and you can click on him and virtually hug/smack/put a heart❤️? I think such an option would add soulfulness to any collaboration.And for purely formal and serious interaction, you can provide an option at the top next to the avatars to disable this function (similar to the Hide Collaborators' Cursors button).

601
Horea Porutiu
Mironeer
10 months ago
R
Ravikiran MajjiBeginner
posted in Developer platform and APIs
Any API to remove user licenses or remove users from MIRO Teams?

Hi, Do we have any API to remove the user licenses or remove users from MIRO team? I can see API to invite users but not able to find option to delete.I referred the documentation and delete apis are deprecated. Please confirm if any API is available to do this task. Thanks, 

105714
Horea Porutiu
Mironeer
10 months ago
S
Siddharth VaishnavNew Here
posted in Developer platform and APIs
How can i get the list of users from every boards using miro api

Is there any way to get the users list from every boards associated with team under single api only as I cannot call the multiple api in my workflow based on the board api I am using auth0 to authenticate the users

651
Horea Porutiu
Mironeer
10 months ago
roberrtt.1211
roberrtt.1211New Here
asked in Developer platform and APIs
From Where Should I Begin?

Hello, all!This is my first post after just joining this discussion, so please forgive me and provide kind assistance if I have posted to the wrong subsection.I am new here but a real enthusiast and loving this community so far. I have a background in teaching coding and in education and feel I could help with documentation, at least for starters.As a new member in this forum and wish to share and gain some knowledge. I am looking forward to create my own discussion to resolve my query and gain some knowledge though I have taken part in various discussion which is definitely helped me a lot.Also what category should be taken depends on what factors? Thankyou in advance.

271
Horea Porutiu
Mironeer
10 months ago
Terms & Conditions