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>

  • 970 Topics
  • 3,076 Replies
970 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

2984
William Bishop
Mironeer
4 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

870
William Bishop
Mironeer
5 months ago
L
Lisa McNabBeginner
asked in Developer platform and APIs
Board stops loading e.map is not a function error and opens save as window when refreshed

While working on a board, it will intermittently stop loading and give the error ‘e.map is not a function ‘ .  When I refresh, chrome opens the save as window.  If I close chrome it works again for a while but this happens sooooo often it’s incredible frustrating.  

20
L
2 hours ago
V
vkokoContributor
asked in Developer platform and APIs
Inquiry About Error Messages for Miro REST API

Hello community,I noticed that there are details about error messages related to the SCIM API available at this link: https://developers.miro.com/docs/errorsHowever, I am looking for similar information regarding the Miro REST API.I haven't been able to find any documentation on possible errors for the REST API.I have encountered some errors during my work, and they do not correspond with those listed for the SCIM API.Am I overlooking something?Thank you for your assistance!BRVas 

101
William Bishop
Mironeer
5 hours ago
V
vkokoContributor
posted in Developer platform and APIs
Clarification on Pagination for Boards and Items

Hello Community,I’ve been exploring pagination for boards and items in the API.I noticed that while boards support offset-based pagination, items don’t seem to provide any offset-related information.Will offset-based pagination be implemented for items as well?Is there a specific reason for this inconsistency, or am I possibly missing something in the documentation?Looking forward to your insights.Best regards,Vasileios

81
William Bishop
Mironeer
1 day ago
G
Guru IntegrationsNew Here
asked in Developer platform and APIs
API "self" Link returns 400 Error

Hi There,I am using the /boards/{boardId}/items endpoint to return all items on a specific board. In the response, I’m getting a number of items returned, and each of those items has a API URL value in the data.links.self field. However, for some of those values, calling the GET endpoint returns a 400 error (code: operationNotSupported).Example response from /boards/{boardId}/items:{ "size": 10, "limit": 10, "total": 11, "data": [ { "id": "3458764607565328883", "type": "shape", "geometry": { "width": 262.06732667592587, "height": 131.03366630422926 }, "position": { "x": -246.9185046725638, "y": 395.1632647477584, "origin": "center", "relativeTo": "canvas_center" }, "links": { "self": "https://api.miro.com/v2/boards/uXjVLCuZXck%3D/items/3458764607565328883" }, "createdAt": "2024-11-19T18:44:56Z", "createdBy": { "id": "3458764584978600694", "type": "user" }, "

81
William Bishop
Mironeer
1 day ago
V
vkokoContributor
asked in Developer platform and APIs
Clarification on Using Tags in Items

 Hi, community!I’d like to clarify which items support tags.From what I’ve observed in the web UI, tags can be applied to sticky notes and cards.Am I correct, or are there other items where tags can be used that I might have missed?Looking forward to your input! BR  Vas

211
William Bishop
Mironeer
2 days ago
S
saifisBeginner
asked in Developer platform and APIs
Can you lock objects made via API when they are created?

I want to lock some objects when having a set of objects created since they act as background objects, I know you can do this on board, but can it be done when created via miro.board.widgets.create?

7858
H
2 days ago
V
vkokoContributor
asked in Developer platform and APIs
Request for Clarification on Item Types in API

Hello Community,I am using the endpoint(https://developers.miro.com/reference/get-items)that lists all items, and by utilizing the `type` query parameter,I can filter the results to specific item types.This feature is fantastic!However, I have noticed that there are additional item types, such as "table" and "unknown," which are not documented.I have a few questions:1. Where can I find a complete list of all available item types?2. Are there plans to include these additional types in the query parameters for filtering?3. Will items with the type "unknown" be renamed to more meaningful names in the future?Thank you in advance for your help!BR  Vas

201
William Bishop
Mironeer
3 days ago
L
LB LNew Here
asked in Developer platform and APIs
Is an App only active, when it is open in the side panel?

Hello everyone,I am new to the Miro development and have a basic question that I need to be solved once and for all: Do I understand correctly that my Miro app can only do things on the board when it is actively open in the side panel?For example: If I want to build an app that changes the viewport when an event happens on the board, I can get that event information using webhooks. But if I want to react to this event, I have to send a command to a Web SDK, e.g. via WebSockets. But this WebSDK app is only active when it is open in the side panel. Please help me understand this fundamental basic of developing for miro. Thanks a lot!

302
L
7 days ago
M
Misol Borba BerenguerNew Here
asked in Developer platform and APIs
Não consigo visualizar meus boards

Ao me logar no miro, não consigo visualizar nenhum dos meus 28 boards.

213
Eca
Mironeer
7 days ago
K
KJoBeginner
posted in Developer platform and APIs
Twitter Integration

It would absolutely transformative for me if I was able to paste Twitter links into Miro and have them appear as tweets. There's just so much information available on Twitter, yet I have to take screenshots to represent it. Maybe not critical to others, but this is critical to me. If Miro isn't able to undertake this development, I would be most grateful for some contact details for developers that might be able to undertake this (paid) work for me. Thanks!

39011
D
7 days ago
V
vkokoContributor
asked in Developer platform and APIs
Is There an API Endpoint to Restore Boards from the Recycle Bin to My Team's Spaces?

Hello everyone,I have a question regarding board management.Is there any API endpoint available that can help me restore boards from the recycle bin and move them to specific spaces within my team's environment?Thank you in advance for your help!Vas

232
V
9 days ago
A
AsyimutNew Here
asked in Developer platform and APIs
Student e-mail deactivated - transfer boards to new educational email acount

Dear Miro Team, I use Miro for all my projects. I recently completed my PhD at the university, where I had been using the email address for my Miro Educational (student) account. I am now employed at another university, and my former email address was deleted, resulting in my Miro account being degraded. My working boards are locked, so I can't even transfer the backup to the new account (the one I am using now to make this post).  I am really scared of losing my data. Can you help me with this please? my old account is: ilguen@student.tugraz.atWarm Regards, Asyimut

171
Eca
Mironeer
12 days ago
V
vkokoContributor
asked in Developer platform and APIs
**Efficiently Retrieving PDF Attachment Binaries from a Miro Board via API**

Hello, community!I have a question regarding attachments on a Miro board.I’m currently working with a board where I used the upload feature to add a PDF file. My goal is to retrieve the binary data of the PDF through the API, but the process seems a bit complex:First, I send a request to https://api.miro.com/v2/boards/{board_id}/items to retrieve the item ID for the PDF document. Then, I use this ID in another call to https://api.miro.com/v2/boards/{board_id}/documents/{item_id}. From this response, I extract the "documentUrl", which looks something like https://api.miro.com/v2/boards/uXjVOfjkmAk=/resources/98765467890987654?redirect=false. I make a request to this documentUrl and get another "url" property with a link to the PDF file, containing an Expires timestamp and signature.Finally, I use this last URL to make a request and download the actual binary file.I'm wondering if there’s a more efficient way to directly fetch the binary without going through multiple steps. Any insights

392
V
14 days ago
V
Vantroeyen EricNew Here
asked in Developer platform and APIs
Authentication token

Hello Is there a way via the APIs to obtain an authentication token to access my tables in my space?I don't need to access another user's data. I want to avoid the Oauth GUI.Can you give me an example if possible?Thanks 

321
Horea Porutiu
Mironeer
16 days ago
V
vkokoContributor
asked in Developer platform and APIs
Help Needed: Permissions Issue with Miro API for Export and Content Log Endpoints

Hello community,I’m encountering a couple of issues related to permissions with the Miro API and would appreciate any insights.1. When running the following request:   GET https://api.miro.com/v2/orgs/{org_id}/boards/export/jobs/{job_id}/resultsI receive this response:   {     "status": 403,     "code": "insufficientPermissions",     "message": "Required scopes: boards:export",     "type": "error"   }I’ve added the `boards:export` scope manually in my app manifest, yet this error persists. Additionally, I couldn’t find any mention of this scope in the documentation.Is this scope deprecated, or could there be another issue?2. I’m facing a similar problem with the following request:   GET https://api.miro.com/v2/orgs/{org_id}/content-logs/items   which returns:   {     "status": 403,     "code": "insufficientPermissions",     "message": "Required scopes: contentlogs:export",     "type": "error"   }Despite adding the `contentlogs:export` scope in the app manifest, I still receive this err

695
V
17 days ago
H
HOLGER ENGELMANNNew Here
asked in Developer platform and APIs
Modal Disclaimer only displayed for Full Member

we had developed an Modal Disclaimer similar to this guide:https://developers.miro.com/docs/display-bannermodal-on-a-miro-board-using-aws-s3No we are facing the issue that the modal is only displayed to full member.  Can we display the banner to guest and free restricted too?

371
William Bishop
Mironeer
20 days ago
V
vkokoContributor
asked in Developer platform and APIs
Sorting Board Items by Group ID using Miro API - Query Params

Hello, community!I’m currently working with board items using the`GET https://api.miro.com/v2/boards/{board_id}/items` endpointand am wondering if there’s a query parameter available to sort these items by group (using the group ID). Sorting by group would be incredibly helpful for my use case, as the `Get groups` endpoint doesn’t quite meet my needs.Thanks in advance for any insights!Vas

313
V
22 days 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

725
Horea Porutiu
Mironeer
22 days 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?

313
Danniel Georgia
22 days ago
E
Enrico RogaBeginner
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

272
E
23 days 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

233
Horea Porutiu
Mironeer
23 days 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?

514
Horea Porutiu
Mironeer
23 days 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

385
Horea Porutiu
Mironeer
23 days ago
Terms & Conditions