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>

  • 954 Topics
  • 3,048 Replies
954 Topics
William Bishop
Mironeer
William BishopMironeer
posted in Developer platform and APIs
Find us on Developer Q&A the first Wednesday of each month

Hey, Miro developers! We’d like to invite you to join our monthly Developer Q&amp;A sessions, a dedicated time for you to get insights on any questions or topics you might have. It is hosted by our Developer Relations team and often we will also have special guests from the Developer Platform engineering and product team to cover more specific topics.  When: The first Wednesday of each month at 5:30PM CEST/ 9:30AM CT, lasting for 30 min. Where: on our Discord channel #developer-Q&amp;A-sessionsWho can join: everyone exploring or building with the Miro Developer Platform is welcome to join - no matter how much experience you have with the Platform, this time is for you.  How to submit topics for discussion:Interested in exploring a specific topic, or have questions on something in particular? Feel free to let us know by adding a comment in this thread or sharing your ideas with us on Discord! For more common questions and topics, feel free to bring up during the session - no advance nee

2784
William Bishop
Mironeer
3 months ago
William Bishop
Mironeer
William BishopMironeer
posted in Developer platform and APIs
ServiceRocket builds 3 new apps on top of the Miro Developer Platform

ServiceRocket builds 3 new apps on top of the Miro Developer Platform Hey, developers!Want to learn more about the art of the possible on our developer platform? ServiceRocket has just launched 3 new enterprise-ready integrations for Salesforce, GitHub, and Autodesk—each built on top of Miro’s Web SDK and REST APIs. Check them out here:Salesforce for MiroThe Salesforce for Miro app enables users to interact with Salesforce data from directly within their Miro board. With this new app, you can now use Miro to manage sales activities, account planning, opportunity management, and more, with a direct connection between Salesforce and Miro.📽️ Watch the demo GitHub for MiroThis realtime, bi-directional sync between GitHub and Miro enhances collaboration across platforms, reduces costs for product and engineering organizations, and increases efficiency. With the GitHub Connector, you can bulk convert GitHub issues to cards in Miro, search and add issues, and more, facilitating better produc

710
William Bishop
Mironeer
4 months ago
A
Amir Ben AriBeginner
asked in Developer platform and APIs
[ERROR] Failed to resolve entry for package "@mirohq/websdk-types". The package may have incorrect main/module/exports specified in its package.json. [plugin vite:dep-scan]

Hey everyone!I have the following code for a Miro Plugin, built/running on vite: import { EventModelType } from "@Models";import { ShapeType } from "@mirohq/websdk-types"; export const SHAPE_TYPES: Record&lt;EventModelType, ShapeType&gt; = {Event: ShapeType.Rectangle,Command: ShapeType.RoundRectangle,ReadModel: ShapeType.Parallelogram,Processor: ShapeType.Rectangle,GivenWhenThen: ShapeType.Rectangle} as const Problem is, no matter where in my code I try to import @mirohq/websdk-types, I’m getting an error when doing npm start:[ERROR] Failed to resolve entry for package "@mirohq/websdk-types". The package may have incorrect main/module/exports specified in its package.json. [plugin vite:dep-scan]  The plugin "vite:dep-scan" was triggered by this import    src/Constants/ShapeTypes/ShapeTypes.ts:2:26:      2 │ import { ShapeType } from "@mirohq/websdk-types";        ╵ Googling for it, I found this issue on GitHub. But nothing suggested there resolved the issue.Any help would be appreciate

214
A
1 hour ago
E
Enrico RogaNew Here
asked in Developer platform and APIs
Add a exsisting TAG to a Item using Python

Hi, i try to add a existing allready TAG to a item (Sticky Note)But i get only the error: enrico@Enricos-MacBook-Pro CPARTJIRA % python test.pyMaking POST request to: https://api.miro.com/v2/boards/uXjVLOuSJng=/sticky_notesHeaders: {'Authorization': 'Bearer ********', 'Content-Type': 'application/json'}Payload: {'data': {'content': 'TEST', 'shape': 'square'}, 'style': {'fillColor': 'light_yellow'}, 'geometry': {'width': 300}, 'position': {'x': 0, 'y': 0}}Response status code: 201Response JSON: Created successfully!Sticky note created successfully with ID: 3458764604900078756Making POST request to create tag: https://api.miro.com/v2/boards/uXjVLOuSJng=/tagsHeaders: {'Authorization': 'Bearer ********', 'Content-Type': 'application/json'}Payload: {'data': {'title': 'hallo', 'fillColor': 'blue'}}Response status code: 400Response JSON: {'type': 'error', 'code': '2.0703', 'context': {'fields': [{'field': 'title', 'message': 'Field [title] of type [String] is required'}]}, 'message': 'Invalid

122
E
10 hours ago
V
vkokoContributor
asked in Developer platform and APIs
Including Organization Details in Token During App Installation

Hello, community!While installing my app, is there any way to include details about my organization within the token?Vas

143
Horea Porutiu
Mironeer
17 hours ago
L
liquidusBeginner
asked in Developer platform and APIs
REST API Token enterprise vs free plan

HiMy app will use enterprise APII wonder how should I refer to particular team in my requests if my app will be installed for whole organization. For example I would like to list boards of each team.Can I use team id’s listed with GET /teams to dynamically change the team I need to refer to?

464
Horea Porutiu
Mironeer
17 hours ago
L
liquidusBeginner
asked in Developer platform and APIs
Purchase plan for ISV

HelloI would like to become ISV for customers of Miro. I would like to use API endpoints available only for enterprise plan. As far as I understand both me and customer must have enterprise plan purchased to be able to authorize my app. I don’t have 30 people in my org, what should I do then? Which plan should I purchase for full API fuctionality?Can I avoid using credit card which can expire and pay with invoice? I want to have bulletproof app with full API support.As far as I understand Miro approval is needed only to appear in marketplace, but my clients can use my app if it’s not published to marketplace, right?BRLiquidus

205
Horea Porutiu
Mironeer
18 hours ago
T
Tim MoserNew Here
posted in Developer platform and APIs
BUG: Rest API creates board in view only

Below is a bug report for some unexpected behaviour I have found when working with the api as a free plan user. Steps to reproduceCreate a board using an access token of a free account through the REST API, noting the resulting board ID (post v2/boards) Create a frame in the board (post v2/boards/ID/frames)Actual Result403 - User is not authorized to create widgets on this board.Upon further investigation in the miro dashboard, I notice that the board is created in view-only, therefore not allowing me (and my access token) to edit it.Expected ResultSince the created board is the most recent board, it should be editable even for free accounts exceeding 3 boards (by making an older one view-only). This would then allow me to also edit it through the api, without the error.

1035
Horea Porutiu
Mironeer
1 day ago
L
liquidusBeginner
asked in Developer platform and APIs
Install app for all team members. API access

HelloI would like to install app to all team members. I know that for business and enterprise plans I can use team admin and org admin. How to achieve this with starter plan? If I will receive content for my app from each user then I will have many tokens to handle which is unacceptable.I need API access to private boards of members in each plan - how should I do this?

213
Horea Porutiu
Mironeer
1 day ago
V
vkokoContributor
asked in Developer platform and APIs
Purpose of team:read and team:write Scopes on Free Plan

Hello everyone,When creating an app, I can clearly see options to select the following scopes:- `team:read`- `team:write`However, on a free plan, I’m unable to use certain endpoints, like `GET Teams` (`https://api.miro.com/v2/orgs/{org_id}/teams`), etc.So, I’m curious—what is the actual purpose of these scopes if they’re restricted on the free plan? BRVasilis

241
Horea Porutiu
Mironeer
1 day ago
X
xarpenNew Here
asked in Developer platform and APIs
Sync markdown txt files from Rider

Hi, so I have this design document that I’m writing for my game, is it possible for me to somehow sync it to Miro board as I change it in Jetbrains Rider?

50
X
2 days ago
R
Rahul PoddarBeginner
asked in Developer platform and APIs
Cant access the recent boards using api

I created a board using the api (https://api.miro.com/v2/boards). I can see the boards in my list of dashboards (https://miro.com/app/dashboard/). However, when I try to access the dashboards using the API (https://api.miro.com/v2/boards), the recent-most board seems to be missing. Even in the api reference playground (https://developers.miro.com/reference/get-boards), when I try to make the get request, it only returns 2 boards, while have 3 (as visible in https://miro.com/app/dashboard/) This has been happening for quite some time now. Please help!

256
William Bishop
Mironeer
5 days ago
V
vkokoContributor
asked in Developer platform and APIs
Fetching Plan Details with Free and Enterprise Accounts in Miro API

Hello everyone,I currently have two accounts,one on an Enterprise plan and the other on a Free plan, and I'm running some tests.To fetch details about my plan, I use the following endpoint:https://api.miro.com/v2/orgs/{org_id}/members,along with query parameters likefull, occasional, free, free_restricted, full_trial, and unknown to filter the results.However, I noticed that this endpoint is only available for Enterprise accounts.My question is:Is there a way to retrieve details about my plan through an API endpoint while using a Free plan?Thanks in advance!

232
V
6 days ago
V
vkokoContributor
asked in Developer platform and APIs
Identifying Board Mode: Edit Mode vs. View-Only Mode

Hello community,Is there a specific field or API endpoint that can determine whether the board is in 'edit mode' or 'view-only' mode?

232
V
6 days ago
S
Shaked OrenNew Here
asked in Developer platform and APIs
Export boards from Miro to pdf

I want to be able to export boards from Miro to pdf, for that - I see in the documentation I need to enable eDiscovery, but in my 'Enterprise integration' window I do not see an option to do so (I'm attaching a screenshot of how that window looks for me).Also, when I built the app in my development team I did not see an option to allow the scope board:export (a screenshot is also provided). 

171
William Bishop
Mironeer
6 days ago
G
Gotrade TechNew Here
asked in Developer platform and APIs
Migrating from Whimsical

Hi, We have a pretty huge board in Whimsical which we wanted to migrate to Miro. Was wondering if there is an easy way to do this via some tool?

28592
Emmanuel Mangatia
7 days ago
V
vkokoContributor
asked in Developer platform and APIs
How Can I Fetch Custom Templates via API or Other Methods?

Hello everyone,I was wondering if there's an available API endpoint or another method to fetch my custom templates. Any insights would be appreciated!

213
Horea Porutiu
Mironeer
7 days ago
T
Tamara DelicNew Here
asked in Developer platform and APIs
Transparent Frame with Rest API

Even though, in REST API Reference I found default fillColor for frame is #ffffff ( ‘transparent’ ), I get WHITE frame when created. How to create transparent frame with Rest API? Is it only possible with Web SDK by setting frame fillColor to ‘transparent’?Thank you in advance,Tamara

322
T
14 days ago
V
vkokoContributor
asked in Developer platform and APIs
Optimizing Miro: Global App Installation, Cross-Plan Collaboration, and Advanced Admin Tools

Hello everyone,I’m an API developer currently building an app for my clients and have a few questions about Miro.1. App Installation Across Teams: When I share the installation link for my app with a client, they are required to select which team the app will be installed in.    Is there any way to modify this process so the app can be installed globally across all teams in the  client’s organization?2. Collaborating with Clients on Different Plans: My company is on the Enterprise plan, and I understand that collaboration is possible with clients who are also on the Enterprise plan.    Are there any limitations or blockers I should be aware of if I want to collaborate with clients using Free or Business plans?3. Administrative Tools: Apart from the Miro App Workflow, does Miro provide any additional administrative tools that can be used to manage apps or permissions more efficiently?Thanks in advance!

467
V
21 days ago
V
vkokoContributor
asked in Developer platform and APIs
Question About Fetching Teams in Miro App for Clients Without Enterprise Plans

Hello everyone!I have a question regarding Miro's Enterprise plans.Our company has an Enterprise plan in Miro, and we're developing an app that we share with our clients. According to the Miro documentation, having an Enterprise plan allows us to use endpoints like this one to fetch a list of teams:Miro API: Enterprise Get Teams: https://developers.miro.com/reference/enterprise-get-teamsIf our clients, who do not have Enterprise plans, install our app on their accounts, will we still be able to fetch their teams, or do both parties (our company and the client) need to have Enterprise plans for this functionality? 

333
William Bishop
Mironeer
22 days ago
S
Sebastian KsollNew Here
asked in Developer platform and APIs
Problem: presentation mode of an embedded board

Hello everyone,Since yesterday, the presentation mode of an embedded board on a website is no longer working. Do you already know about this issue? I have already tested it with a test board. The board opens, and I can see the frame, but not in presentation mode. It’s important to me to be able to navigate from frame to frame using the arrow keys.I have tried it on both a Windows and Mac system and with different boards and different explorers.Can anyone replicate the problem or explain what the issue might be? For testing, I used the standard HTML code and inserted the iFrame code of the board into the body. &lt;!DOCTYPE html&gt;&lt;html lang="de"&gt;&lt;head&gt; &lt;meta charset="UTF-8"&gt; &lt;meta name="viewport" content="width=device-width, initial-scale=1.0"&gt; &lt;title&gt;Beispielseite mit iframe&lt;/title&gt;&lt;/head&gt;&lt;body&gt; &lt;h1&gt;Willkommen auf meiner Seite&lt;/h1&gt; &lt;p&gt;Hier ist ein eingebettetes iframe:&lt;/p&gt;&lt;iframe&gt; &lt;/iframe&

481
William Bishop
Mironeer
22 days ago
S
spoke_danBeginner
asked in Developer platform and APIs
How can I get Shape styles using the 'bulk' endpoint?

I’m using the bulk endpoint (https://developers.miro.com/reference/get-items) to get specific item type on a board. My first call I use the endpoint with the following params: “?type=sticky_note&amp;limit=50” in order to get the first 50 sticky notes. This works as expected and I get the sticky notes with geometry, data, position, and style.However, when I run the same query but with “?type=shape&amp;limit=50”, I can the same results minus the shape styles. This is annoying since I would have to the re-query (I think) for each shape to the specific shape endpoint (https://developers.miro.com/reference/get-shape-item) to get the styles.I would’ve expected the bulk endpoint to just give them to me.Is there a reason it’s doing this? Am I missing something? 

294
William Bishop
Mironeer
27 days ago
V
vkokoContributor
asked in Developer platform and APIs
HTTP Status Codes in Miro REST API

Hi everyone,I'm trying to find a comprehensive list of all the possible HTTP status codes that I might encounter while working with the Miro REST API. I’ve looked through the documentation but wasn’t able to locate anything specific.Any guidance would be greatly appreciated!Thanks in advance!

170
V
27 days ago
K
KalimuthuZluriBeginner
asked in Developer platform and APIs
Enable enterprise scope on developer app

Hello Team,I have an old developer App that is used by multiple users. Now, I want to enable additional scopes in the app, but the scopes are not getting enabled.These are the steps I'm following: I click on scopes to add, then click install app. It says it's successfully installed and returns with an access token, but I refresh the page to confirm and it's actually not added.I would really appreciate any help fixing this as soon as possible.   

8410
C
Mironeer
27 days ago
M
Md Tauseef AhmedNew Here
asked in Developer platform and APIs
Polarion Integration with Miro instead of Draw.IO

Hello Team,One of our clients is interested in integrating Miro’s drawing features into Polarion Live Docs. Currently, we have the Draw.IO feature available out-of-the-box in Polarion, but the client prefers Miro. Their requirements are as follows:Engineers will create drawings and templates in Miro. They want to export or move these drawings from Miro to Polarion Live Docs. Double-clicking the drawing image in Polarion Live Docs should redirect to the Miro application.As the Polarion Solution Architect, I am conducting a feasibility study and need access to Miro’s APIs. Based on my research, REST APIs seem suitable for this integration. I have a few questions:Can we access REST APIs on the trial version? Is it possible to access drawings from Miro through REST APIs for use in third-party applications? What are the costs for the premium version on a monthly and yearly basis?Thank you for your assistance. Your prompt response is highly appreciated.Regards,Md Tauseef Ahmed

553
Horea Porutiu
Mironeer
29 days ago
Terms & Conditions