Skip to main content

Developer platform and APIs

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

  • 1,073 Topics
  • 3,327 Replies
1068 Topics
A
Ankush KulkarniContributor
posted in Developer platform and APIs
Displaying Miro board in our application without logging in to Miro

Dear Miro Team,We want to display Miro board into our application without asking user to sign-in to Miro. We want the users to log in our application (we are using OKTA as authentication/authorization mechanism) and will navigate to the page where we display miro board in the iframe. Even is the user is not logged in to Miro and he does not have the miro cookie, we want to display the board. Is that possible or miro login is mandatory before displaying the board?

33614
A
H
HarshitaVishwakarmaContributor
posted in Developer platform and APIs
MIRO oauth API endpoint throws 401 invalid refresh refresh token

I am using expiring access-tokens in my application. I followed the steps here for the authorization process. Everything works fine until we reach the step5: where we try to fetch the access-token using the refresh-token.I store the refresh-token in the backend and make an API call to fetch the updated access-token whenever a MIRO REST API is called, and update the refresh_token in case the fetched refresh_token is not the same as what I have stored in the backend. Everything was working fine up until yesterday, now I keep getting this error:{  "status": 401,  "code": "oauthError",  "message": "Invalid refresh token: <refresh_token>",  "type": "error"}And for some reason with every call to this API https://api.miro.com/v1/oauth/token?grant_type=refresh_token&client_id=CLIENT_ID&client_secret=CLIENT_SECRET&refresh_token=REFRESH_TOKEN the refresh_token returned is changed. Even though it shouldn’t because according the docs it doesn’t expire unless it’s been 60 days. An

2262
H
D
DebAcademyNew Here
posted in Developer platform and APIs
I hope i can use Miro board in Spatial.io,

I hope  i can use Miro board in Spatial.io,

390
D
B
Bram de VriesNew Here
posted in Developer platform and APIs
Send objects back and forward in steps

Miro would be more helpfull and easy to manage if objects, icons, photo’s en text could send back, forwards in steps.

15581
Henrik Ståhl
H
HarshitaVishwakarmaContributor
posted in Developer platform and APIs
Is there any way to list the teams a user is a part of using REST API ?

I have a requirement to fetch the list of teams a user is a part ofPlease help on how I can achieve this? 

15812
H
S
Shane FitzroyNew Here
posted in Developer platform and APIs
How to connect two shapes with a line using the REST API v2.0?

Hi there,Using the REST API v2.0 I’ve created two basic round_rectangle shapes and I’ve retained their IDs from the JSON response. How do I create a line that connects the two shapes using the REST API?It would be great if I could also set the following for the line if possible:The line’s colour and line style (dots/dashes). The start-end arrow head style.Thanks in advance.

791
Max Harper
O
Omar Eduardo HernandezBeginner
posted in Developer platform and APIs
How can I use SDK v1 functionality

I recently created an app  with the SDK v2, then I realized that the functionality I want is on v1. How can I use the SDK v1 functionality? I tried usingmiro.v1since that works in the browser using dev tools, but it looks like is not available when running the app.

893
O
H
Harshita VishwakarmaBeginner
posted in Developer platform and APIs
How to get the organization id using the REST API?

I am trying to list all the teams within the organization using the list all teams V2 REST API, which requires the org_id as the parameter, I have looked through the docs but didn’t find anything on how to get the org_id. Please help.

8501
H
P
pablo.anglatNew Here
posted in Developer platform and APIs
User management in an application in which a Miro board is embedded

Hi,We are testing how we can embed a Miro board in an application, and we have a couple of questions about user management. We are using, for now, a Developer account.1) Is it possible to create a user via the Miro REST API using the Developer account (to test the feature)?2) After creating the account via the Miro REST API, does the user need to login into Miro to access (to edit) one board? Or is there a mechanism to avoid the Miro login page/popup?3) If an already created user moves to another device (where they are not logged in to Miro) is there any mechanism to log them using the REST API to avoid the Miro login page/popup? 4) Who will be the Miro user when an API-created user logs into the app that embeds Miro board? 

320
P
C
Carlos Carvalheiro-NunesNew Here
posted in Developer platform and APIs
MIRO HOLODECK

One of the biggest upgrades Miro could make would be the ability to load 3D STEP files for collaborative engineering within a Miro board, and allow for basic model manipulation similar to what is possible in programs like Fusion 360 or Solidworks but in a collaborative space, there currently is nothing like that available which is crazy in 2022, this capability would create a incredible collaboration experience that would create a MIRO HOLODECK. If this is being considered and is going into Beta testing, I would happily be a beta tester for that functionality, staying the 2D FLAT Plane is great for certain things but you are trying to imagine the Z AXIS there is nothing like showing people depth and form in it’s truest form without VR headsets.

220
C
H
Harshita VishwakarmaBeginner
posted in Developer platform and APIs
Update the date on a card to null or to clear it via REST API

I am trying to update card data on a board via this REST API. The “title”, “description” etc are updating successfully. But there’s an issue with updating the “date” to null/empty if there’s no date coming from the back-end. I have tried sending the null/undefined/empty date like this:{"data":{"title": "updated title", "dueDate" :null, "description" :"updated description"}Because I want to clear/remove the date on the card when I call the card item update API endpoint. But so far the existing date on the card still remains as it is. Please do help on how the date on the card can be updated to null or cleared/removed.

972
H
I
ikarstNew Here
posted in Developer platform and APIs
API access on Non-Developer-Account with "Consultant" Plan

Hi!I want to enable API access to my boards.My plan ist “Consultant”.I have another account as “Developer”. There I can create ClientID/ClientSecret.But how does this work with a “real” miro board? 

983
William Bishop
Mironeer
J
JuanfraBeginner
posted in Developer platform and APIs
is the toolbar customizable using the SDK 2.0?

Hi,I’m working on an App that will have an embedded Miro, and we will have different users with different features around the canvas.I’m wondering if the toolbar can be customizable? can I remove any item depending on the type of users I have in my application?I know we can actually “hide” elements from the parent toolbar by moving them to a second level, but I’d like to really remove some features in the toolbar depending on my different types of users. Thanks in advance.Regards,Juanfra

363
Addison Schultz
Mironeer
J
JuanfraBeginner
posted in Developer platform and APIs
can I get the events of the elements inside the canvas using the SDK?

Hi,I have my own web site with an embedded Miro live board.Can I get the events from the elements inside the canvas using the SDK2.0?I mean, is there a way to listen for instance a click event done on a card inside the canvas board? I’d like to add more features needed in my application after clicking on some elements inside the canvas. Thanks in advance.Regards,Juanfra

971
Addison Schultz
Mironeer
E
Emile Paffard-WrayBeginner
posted in Developer platform and APIs
How to get embed urls from the REST API?

I’m trying to get some data from boards using the REST API and I want to get the URLs of embeds, however the url field is always empty for embeds like below:{ "id": "34587645207273844312", "type": "embed", "title": "Preview the Timer", "url": "",}Is there some way of populating this information? Edit: Same question goes for retrieving images - where is the image data and/or URL

1493
William Bishop
Mironeer
C
circle extraNew Here
posted in Developer platform and APIs
I want to create a board in C# using the Miro (https://miro.com) API

I am building a .NET Core 6.0 WPF application in Visual Studio 2022 Community. I want to create a board in C# using the Miro https://miro.comtable-sale API. I have obtained CliendID and ClientSecret for authentication. I added RestSharp with NuGet and wrote the code below. It goes through to authentication.After that, I am posting to api.miro.com/v1/board, but I get the error Unauthorized. How can I post? public string MiroUserProfileUrl = "https://miro.com/app/settings/user-profile/apps"; public string ClientID = "myclientid"; public string ClientSecret = "myclientsecret"; internal async void CreateBoardAtMiro() { try { var client = new RestClient("https://miro.com/app-install/?response_type=code&client_id="+ ClientID); var request = new RestRequest(); request.Method = Method.Post; request.AddHeader("Authorization", "Bearer " + ClientSecret); var resp

4522
Addison Schultz
Mironeer
M
Mark McIntyreBeginner
asked in Developer platform and APIs
Sketch Miro Problem eoor during syncing after upgrading to Sketch 87.1

I had an existing Sketch file which was working fine when we used the Miro plugin it sync the artboard to Miro. We could work without issue, update the artboard on the Sketch file and then resync to miroThis would then replace any existing instance with the update art boardWe upgraded to Sketch 87.1.Now if we try an resync it to the Miro board we get an error“An error occured.There was an error during syncing. Please Try again”If we create new artboard in the doc and sync that it works as expected. Plus we can update and resync without issue. 

17411
J
T
Thato MpudiNew Here
posted in Developer platform and APIs
API retrieval

Hi, I have recently created a board on Miro and I would like to retrieve its API. Could you kindly assist me?Thanks

283
Addison Schultz
Mironeer
L
li nanBeginner
posted in Developer platform and APIs
BUG - ICurveWidget.style.lineWidth property is missing

Hi, i’m recently working on an app that depends on the `ICurveWidget.style.lineWidth` property to act properly, but it dosen't exist. Hope you guys can fix it, thanks.  

204
L
D
Dylan RichardsNew Here
posted in Developer platform and APIs
REST API V1 Invite To Team Error 500

Hello Miro Community,I am building an onboarding automation and I’m using an HTTP request to invite users to our team. Here is what I have so far:{    "uri": "https://api.miro.com/v1/teams/{team_id}/invite",    "method": "POST",    "headers": {        "Accept": "application/json",        "Content-Type": "application/json",        "Authorization": "*sanitized*"    },    "body": {        "email": "{user_email_address}"    }}I do have the team_id correct in the actual request and the bearer token inserted in the Authorization header. I’m following the instructions here. I can run this request in Miro’s test request on this page and it works fine. However, when I send my request from my automation, I get this error:   "body": {        "status": 500,        "code": "internalError",        "message": "Internal Error",        "type": "error"    }Has anyone else run into an issue like this? Is there something I can adjust in my request to get this to run successfully?

373
William Bishop
Mironeer
A
ArkadeBeginner
posted in Developer platform and APIs
BUG: v2 REST API: get-items-within-frame doesn't seem to work

Hi, hope this is the right place to feed back with a bug report.  Someone please redirect me if not I think there's a bug with https://beta.developers.miro.com/reference/get-items-within-frameOthers calls I’ve used so far work fine for me (suggesting user error is unlikely ).Firstly and most importantly, the NodeJS version (which I'm using) fails saying:Sorry, `get-items-within-frame` does not appear to be a valid operation on this API. Other things that suggest there are problems:Notice it mentions `localhost` in ref at top The shell version URL just says `items`.Thanks and HTH!

1169
William Bishop
Mironeer
S
samsamm777New Here
posted in Developer platform and APIs
Web plugins examples do not work

Copy and pasting the web-plugin examples do not work.I tried this example, and it give an error relating to ‘create’ being undefined.const viewport = await miro.board.viewport.get()const centeredX = viewport.x + viewport.width / 2const centeredY = viewport.y + viewport.height / 2miro.board.widgets.create({type:'sticker', x:centeredX, y:centeredY})I looked through the miro.board object properties in the console, and ‘widgets’ does not exist.I do however have a bunch of functions like ‘miro.board.createSticker’. Am i on and old version or something? How do i get these examples working?

631
Max Harper
G
Georgiy EfremovNew Here
posted in Developer platform and APIs
Does any know how to export miro board as any structure with information about objects on it?

Hey guys.  I have a tree in my miro board. Structure is simple:  nodes are text, connection between - arrows.  I know that there is option to export information as csv but this is works only for text.  Is any ability to export informations about arrows(connections)? (any structure)  Many thanks

16652
K
M
Manuel KochBeginner
posted in Developer platform and APIs
Board Backup export/import REST Integration

Hi,Do you have any plans around to provide API functionality around the topic “Backup”https://help.miro.com/hc/en-us/articles/360017572774-Board-Backupto be able to build export/import automation over REST?GreetingsManuel  

3913
M
O
Omar Eduardo HernandezBeginner
asked in Developer platform and APIs
Get asignee user info from card using SDK

Is there a way to get the user information from a card assignee using the web SDK?When I select a card widget I get an object similar to this:{    type: ‘card’,    assignee: {        userId: ‘xxxxxxxxxxx’    },    ….}How can I get that user name from the assignee?I am trying to build a custom csv export, so I need that information.

551
William Bishop
Mironeer
Terms & Conditions