Developer platform and APIs

Discuss everything related to Miro API, SDK, embedding and Miro Platform apps development. See documentation at developers.miro.com

  • 486 Topics
  • 1,569 Replies

486 Topics

T
Tom GuestNew Here
posted in Developer platform and APIs

Update shape item API endpoint not working as expected

I’m using the PATCH https://api.miro.com/v2/boards/{board_id}/shapes/{shape_item_id} to try and change the text content and background colour of a shape. The request I am using (via https://beta.developers.miro.com/reference/rest-api-update-shape) is curl --request PATCH \ --url https://api.miro.com/v2/boards/<board_id>/shapes/3458764521610298308 \ --header 'Accept: application/json' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "data": { "content": "new text" }, "style": { "fillColor": "#d0e17a" }}'which results in...{ "type": "error", "code": "invalidParameters", "message": "Position (x and y) is required", "status": 400}if change the request to only include the “style” section i get a 200 response.I have added a position block but that doesn’t change the response.Any ideas?

2
Joanna Smith
Mironeer
2 months ago
N
nick bogaertNew Here
asked in Developer platform and APIs

Company Templates feature on consulting plan

We are on a consulting plan and create a team for every client we work with. We recently put a lot of effort into creating miro templates for all our tools to realize that we have to add these to every team separately. This is not only a lot of unnecessary work every team we add a new client, it also means that we can’t change our templates centrally. The current workaround - copy pasting templates from our company team into boards for client teams -is time consuming and creates a lot of clutter in the form on unused boards on our company team. The feature to make this accessible across team accounts already exist on the enterprise plan. Given the nature of most organizations that are on the consulting plan it would make a lot of sense to add it to the consulting plan as well!

2
Dominique Rolink
Mironeer
2 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

4
L
2 months ago
D
DaveCNew Here
posted in Developer platform and APIs

Table access via Web SDK

I’ve not seen anyway to gain access to a table via the Web SDK, for example to create rows/add data, as well as read the data within the table structure.  Is this the case?  If not, is there any plan to implement it?

2
D
2 months ago
E
Emile Paffard-WrayBeginner
posted in Developer platform and APIs

User can't select team when installing my app

Hi there, I’ve created a Miro app which uses the OAuth flow to integrate with the REST API. A user has just tried to install the app and told me that they cannot select a team, screenshot below: As far as I can tell this is not an issue on my side, it seems like a bug with Miro - any ideas what the problem is?

3
E
2 months ago
P
Paul HopkinsBeginner
posted in Developer platform and APIs

appData with REST API

Hi, I am using the new v2 REST API and I would like to use either metadata at the widget level as per the v1 API or the appData that is available through the SDK https://beta.developers.miro.com/docs/board_board#setappdata but it doesn’t appear to be exposed to the REST API board model https://beta.developers.miro.com/reference/board-modelIs that correct? Is there a plan to expose it?

2
P
2 months ago
K
kirillkirillkirillBeginner
posted in Developer platform and APIs

Getting tags info using Miro API

Hi, are there any possibilities to get tags info from board?I want to get info from tags attached to board objects.For example, i want to read two tags from tihs sticker using API 

3
Anthony Roux
Mironeer
2 months ago
SandroSp
SandroSpNew Here
posted in Developer platform and APIs

Building External Backend to copy boards of team - having difficulties with "dev team"

Dear all, I’m currently building a React app to generate automated miro exercises. The goal is that a user has the possibility to start an exercise and be directly forwarded to a board in our organization with public access rights. Currently I’m having difficulties to create these boards via the API outside the Developer Team. As far as I understood, I can export my application to other teams, but then I can't create an access token for this team or cannot access this team with my old one. It seems like I need to generate a new access token. But I’m incapable to do it. I would be happy about any help. Or please provide information on how else I could generate these boards outside the developer team. See below for my basic interaction diagram.  Thank you!Best regardsSandro

1
SandroSp
2 months ago
E
Emile Paffard-WrayBeginner
posted in Developer platform and APIs

How does the geometry work for widgets on the REST API?

Hi, I’m building an application that transforms widgets using the REST API and I’m having some trouble understanding why the coordinates in the API response don’t seem to correspond the coordinates on my Miro board. I have for example a frame with text inside it on my board as shown below: Clearly the text is inside the frame and, to my intuitive understanding, should have a higher x coordinate than the frame which contains it. However, in my REST API response I have the following: // Frame{ "type": "frame", "x": -3587.3270314932, "y": -5206.0307250572}// Text inside frame{ "type": "text", "x": -3698.5956533089, "y": -4955.33351925148}As you can see the x coordinate has a lower value for the text than for the frame. Is there a clear description somewhere of how these coordinates are generated? (And therefore how I might manipulate them to have values that correspond to the visual appearance).

2
E
2 months ago
Robert Johnson
Robert JohnsonVolunteer Community Moderator
posted in Developer platform and APIs

Deleted Developer Team - not can't delete apps OR create a new dev team

Full disclosure: I have submitted a support ticket, but thought I would check here to see if anyone has ran into a similar situation and resolved it on their own as I am feeling stuck.A while back, I created a Developer Team using the following URL: https://miro.com/app/dashboard/?createDevTeam=1I then created six apps.Yesterday, Iuninstalled the apps from a few of my teams. deleted my Developer Team. Where is happening now - I cannot:delete the apps I created. When I go to my Profile settings → Your apps → select one of my created apps and then use the Delete app action, I receive an error of: Account not found: And when I try to create a new Developer Team using this URL: https://miro.com/app/dashboard/?createDevTeam=1, I get an error that User has already created a developer team (or something very close to that - it disappears quickly, and doesn’t always display, so I could not capture it).Has anyone else ran into this and had it fixed? I really need to keep this Miro account prof

1
Robert Johnson
2 months ago
M
Manuel HessBeginner
posted in Developer platform and APIs

Prevent scrolling in embeded Miro board

Hi everybody, I am currently working on a web based prototype that integrates different areas of a Miro board via iframes. I currently face the following challenge:When you load a web page that integrates a part of a Miro board via iframe and scroll down the page, the mouse gets capture in the iframe and you continue scrolling within the Miro board. So you happen to have a completely different area of the board visible in the iframe.Any chance to prevent this? So ideally kind of fixing the area of the board that is visible in the iframe?As a workaround I put a button below the iframes that simply reloads the iframe and thereby “centers” the view again. But that’s not very usery friendly. Thanks for helping!

3
J
2 months ago
M
Manuel HessBeginner
posted in Developer platform and APIs

Error 500 when trying to get all frames via API

Hi there,I am trying to get all frames from a specific board via API. For any other item type the Get items by type on board method works fine for me but trying to get the frames constantly get the following error no matter for which board i try it:{  "type": "error",  "code": "internalError",  "message": "Internal server error",  "status": 500}I get the error using the API reference website for trying out. Is that a known issue? Thanks and regards,Manuel

6
M
3 months ago
H
highbeeBeginner
posted in Developer platform and APIs

insufficientPermissions: Create board API, Required scopes: boards:write

Hello, I am integrating miro API to a third party App and I wanted to use create board and widget API, After using the OAuth to get token for authorization, and having set the required parameters as stated in the documentation, I kept getting “insufficient permission” response code. Below is the sample of response I got:{  "status" : 403,  "code" : "insufficientPermissions",  "message" : "Required scopes: boards:write",  "type" : "error"} 

3
H
3 months ago
M
maedaBeginner
posted in Developer platform and APIs

The characters on the figure do not become bold.

I'm now trying to output a shape using the SDK. Therefore, I would like to make the characters in the figure bold. miro.board.widgets.create ({{ type:'shape', x: 0, y: 0, width: 100, height: 100, style: { textColor:'# 000000', backgroundColor:'#FFFFFF', bold: 1, borderWidth: 7, borderColor:'# 000000', fontFamily: 0, fontSize: 32, textColor:'# 000000', shapeType: 3, }, }) Even if you do, it will not be bold. Please let me know if there are any mistakes.

1
Anthony Roux
Mironeer
3 months ago
M
maedaBeginner
posted in Developer platform and APIs

Please tell me about the width of the Left Sidebar

Can the width of the leftsidebar opened using the "openLeftSidebar" method be changed to something other than 340px? It seems that you can change the width as an option, but when I try it, it doesn't work. https://developers.miro.com/docs/web-plugins-features#render-custom-views  

3
Addison Schultz
Mironeer
3 months ago
M
maedaBeginner
posted in Developer platform and APIs

The permissions error has occurred

I have created and am using an application that drags and drops icons. I define the permissions my app requires to modify boards when I install it, but after a certain amount of time, the permissions is broken and the following error occurs. I can't drop the icon on the board. Uncaught (in promise) Error while command execution: Method 'board.widgets.create' requires scope 'boards:write'   if anyone have an idea of how to fix it.

2
M
3 months ago
I
Ionut AnisiaBeginner
posted in Developer platform and APIs

Boards Picker API

Hello,We want to integrate MIRO in our product. In order to do that, we want to use the boards picker API. For this, we submitted the necessary form on the 29th of April 2021.To date we have not received any answer regarding our request. I sent multiple messages on this topic to the support team but have not received any answer. Has anyone gone through the same process or can give us some tips and tricks on how to get things moving? The deadline we set for this integration is coming soon and time is of the essence.Thank you in advance for your support! 

4
Joanna Smith
Mironeer
3 months ago
A
Aaftab V MohammadNew Here
posted in Developer platform and APIs

Unable to access Miro Boardspicker API

Our company has created a dev app and applied for that app to get access boardspicker api via this form, about 20-30 days ago. I still get the ‘Sorry Integration is unavailable error, when trying to create a board by boardspicker api in my local. I have added localhost to boardspicker domain in our app settings. Here is the error. Thank You. 

1
Anthony Roux
Mironeer
3 months ago
Blake Cottington
Blake CottingtonBeginner
asked in Developer platform and APIs

User and Team Management via API

Hi Miro Developer Community. Question - it seems like there is no way to do these things using the API:List all users in the company, and their license level List all teams in the company Create a new teamIs that right? I saw another post saying that you can use Get Team User Connection to list team members and their role. But that’s just for one team. Is there another method for doing this? Or is there a plan to offer this in the API? Doing these things manually is real pain if your company has hundreds of users or hundreds of teams.  Thank you in advance!

15
Geoffrey Lee
3 months ago
gavin032
gavin032Contributor
posted in Developer platform and APIs

Detect Pre-selected widgets when plug-in loads

Hello!I am developing a plugin that can be opened from the Miro board. When my plug-in starts, it doesn’t check if widgets are already selected. I need the plugin to be able to detect what is currently selected when it is opened in order to improve the user experience.Has anyone figured out how to do this?Here is a video demo of the issue: 

6
gavin032
3 months ago
N
niklaslavrellBeginner
asked in Developer platform and APIs

Force the iFrame embed widget to run inline directly the board

Hi Miro,Some iFrame embed widgets seems to run (when you press the play icon) inline directly on the board (e.g. Youtube & SoundCloud) and some run in the popup modal view (e.g. Spotify, Product Hunt). I’m building a web app (to run inside the iFrame embed widget) and a Miro web-plugin, how can I make the embed widget to run inline directly on the board? I can’t find any documentation or references in the SDK.Cheers,Niklas

5
J
3 months ago
M
mor220New Here
posted in Developer platform and APIs

Getting 500 Server Error while using the "fileds", "offset" params

Using this endpoint: GET https://api.miro.com/v1/teams/{id}/user-connectionswhile using the “fields” param I get server error before getting all the dataExample -First call:https://api.miro.com/v1/teams/{id}/user-connections?fields=id,role,user{id,name,email,state}&limit=100&offset=0Status 200 OK"type": "list","limit": 100,"offset": 0,"size": 288, Second call:https://api.miro.com/v1/teams/3074457346633267435/user-connections?fields=id,role,user{id,name,email,state}&limit=100&offset=100Status 200 OK"type": "list","limit": 100,"offset": 100,"size": 288, Third call:https://api.miro.com/v1/teams/3074457346633267435/user-connections?fields=id,role,user{id,name,email,state}&limit=100&offset=200Status 500 Server Error"type": "list","limit": 100,"offset": 200,"size": 288,

0
M
3 months ago
Fredrik Wendt
Fredrik WendtContributor
posted in Developer platform and APIs

Lock & Hide Frames via REST API

We run workshops and trainings, usually with about 100 frames/exercises. For every class/workshop, these are copied from a template and there’s usually some manual tweaking to be done by the trainer. I set out to write a simple tool that would unlock & unhide all frames, let the trainer make some tweaks, and then run the tool again to lock (in place) and hide (to prevent peaking ahead) all frames.I was surprised that frames are readonly. Is there any workaround to this issue of having to click at least 200 times (lock, hide) to get ready to run a workshop?

3
N
3 months ago
S
shin_yasueBeginner
posted in Developer platform and APIs

Can I add my own shapes?

I am new to MIRO and English, so sorry if this is a strange question.Is it possible to add my own shapes using the API?Specifically, I would like to be able to drag and drop a shape like a crown onto the board.I have used SVG before, but I want to change the color of the lines and the background color, so I want to achieve this with shapes.Please give me some ideas!

10
Addison Schultz
Mironeer
3 months ago
S
Siddhant KumarNew Here
asked in Developer platform and APIs

Sorry, integration is unavailable.

When i tring to use  this is code miroBoardsPicker.open({ clientId: '***********', // Replace it with your app ClientId action: actionSelect.value, success: (data) => { resultsBox.innerHTML = JSON.stringify(data, null, 4) resultsBox.style.display = "block" } }) it is giving me error in console Error. Account is not a partner. Reason is accountIsNotPlatformPartner   and on chrome popup Sorry, integration is unavailable.

12
A
3 months ago
Terms & Conditions