Skip to main content

Developer platform and APIs

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

  • 1,048 Topics
  • 3,285 Replies
1043 Topics
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!

42011
D
V
vkokoActive Contributor
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

372
V
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

391
Eca
Mironeer
V
vkokoActive Contributor
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

522
V
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 

581
Horea Porutiu
Mironeer
V
vkokoActive Contributor
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

925
V
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?

441
William Bishop
Mironeer
V
vkokoActive Contributor
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

453
V
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<EventModelType, ShapeType> = {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

4645
Horea Porutiu
Mironeer
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

382
E
V
vkokoActive Contributor
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

273
Horea Porutiu
Mironeer
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?

674
Horea Porutiu
Mironeer
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

1005
Horea Porutiu
Mironeer
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.

1165
Horea Porutiu
Mironeer
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?

463
Horea Porutiu
Mironeer
V
vkokoActive Contributor
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

551
Horea Porutiu
Mironeer
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?

320
X
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!

406
William Bishop
Mironeer
V
vkokoActive Contributor
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!

292
V
V
vkokoActive Contributor
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?

332
V
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). 

681
William Bishop
Mironeer
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?

32412
Emmanuel Mangatia
V
vkokoActive Contributor
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!

683
Horea Porutiu
Mironeer
V
vkokoActive Contributor
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!

627
V
V
vkokoActive Contributor
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? 

403
William Bishop
Mironeer
Terms & Conditions