Skip to main content

Developer platform and APIs

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

  • 1,042 Topics
  • 3,271 Replies
1038 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&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&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

3794
William Bishop
Mironeer
P
Pepe CáceresBeginner
posted in Developer platform and APIs
How to upload new image using API v2

Hi!! I would appreciate if someone could give me an example of uploading a new image with https://api.miro.com/v2/boards/{board_id}/images described (not completely) in https://developers.miro.com/reference/create-image-item-using-file-from-deviceIn fact, what I’m trying is duplicating an existing image in a board into a new one. Because its url is private, I cannot use it by speciffying its url so I’m reading its content and trying to upload it in the same way if it would be an image from device. Thanks in advance!!!

3399
S
J
JimmyyyNew Here
posted in Developer platform and APIs
StickyNote.style.fillColor is always "light_yellow" in REST API

Hello,I’m using the REST API to request information from a board, using `GET /v2/boards/{board_id}/items`. I have some sticky notes in different colors in my board, however the returned `fillColor` in `style.fillColor` is always `light_yellow`, even if the sticky note has a different color. Other style properties (e.g. `textAlign`) work correctly - but the `fill_color` is always `light_yellow`.I’ve implemented this functionality ~1 year ago, and it definitely worked back then - did something change that broke this, is this a bug or intended behavior? If intended, is there any other way to figure out the color of a sticky note?

303
M
S
sophia.beatonNew Here
asked in Developer platform and APIs
Changing Team Admin

Hello, unfortunately our team admin recently passed away. How can we change it to another person?Thanks,Sophia

81
Robert Johnson
B
Borau Gonzalez Carlos BSHBeginner
posted in Developer platform and APIs
Having Get organization members and List team members API calls return users Display Name just like Get all board members call

As the title says, the only way to get a user’s Display Name through the API is with the Get all board members call. I believe it would be reasonable to have both Get organization members and List team members API calls also return the user’s display name.

132
B
Learny Teams
Learny TeamsNew Here
posted in Developer platform and APIs
Hi, I´m looking for a Miro developer to apply Ai functionalities

We want to automatize some steps of our workshop with AI

182
Eca
Mironeer
kubens_dev123
kubens_dev123Beginner
posted in Developer platform and APIs
API: Big bug with updating parent of an item.

Hello,I’ve found out that updating parent of an item (via PATCH boardID.type.itemID endpoint) does not work properly in a specific scenario:You want to move an item to a frame that was created after the item was. Such operation results in adding the item to frame’s children list, but the item is hidden and invisible under or below the frame. While moving the frame, the item moves along. It is also very inconvenient to bring this item back to the foreground.Updating parent works correctly only when trying to move an item to pre-existing frame. 

483
kubens_dev123
V
vkokoActive Contributor
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

612
S
L
LucasWNew Here
posted in Developer platform and APIs
Custom app won't show

I’ve been trying to create a custom app, but it seems like no matter what I try, it won’t show up in the Miro board(s).I created an app with a development team. Tried hosting it locally and through online services that seem to work fine except for in Miro. I do get one message in the app editor UI: “Change the app URL to a publicly reachable one. All your redirect URIs should be publicly reachable, these aren't: “ And it has been the same regardless of which URL i put in. Local (even though it says locally hosted ones doesn’t have to be publically reachable), online - doesn’t matter.I install the app to my team and try in the board but it won’t show. I’ve subscribed to icon click event, and I’ve disabled any browser integrations that might cause conflicts. I tried different browsers and the desktop app - no difference. I’m at a loss. Anyone got a clue what I can try? Any help will be greatly appreciated.

241
William Bishop
Mironeer
D
DritonNew Here
asked in Developer platform and APIs
First time creating a Miro app problem

Hello!So yesterday I got an idea that I wanted to create a app in Miro and i started searching how I can do so and found a great guide on how to get me started but I gave up quite fast because things where not working on my work computer due to some restrictions.So I ended up deleting the “Developer team” (I think It’s called), but now when I want to do the same thing again i get the error or warning saying “User has already created developer organization“ but I can’t find any developer organization or team…?I have created a case on this but maybe someone here has an idea on how I can solve this? Thanks,Driton

312
Robert Johnson
L
lowedirectNew Here
posted in Developer platform and APIs
Is it possible to receive and process webhook responses directly in Miro?

Hi everyone! 👋I'm working on an integration between Miro and a third-party service for validating user data. I'm using webhooks to send information from a Miro board or app, and while the webhook sends successfully, I'm unsure how to handle the response.From what I’ve found so far, it seems Miro does not have built-in support to process or react to webhook responses — meaning I might need to build a backend service that receives the webhook, performs the validation, and then updates Miro via its REST API.Can anyone confirm if this is the correct approach? Or is there a way within Miro (e.g. using apps or SDK) to handle webhook callbacks and update board content or properties automatically?Thanks in advance for any help! 🙏

10
L
E
Egor KraevBeginner
asked in Developer platform and APIs
Webhooks not triggering on mind map node creation?

Hi,I’m running the example app athttps://github.com/horeaporutiu/miro-webhooks-python , having set it up as per the instructions at https://developers.miro.com/docs/getting-started-with-webhooks-pythonStrangely, it looks like the app only gets called when nodes in the mind map are modified or deleted, but not when they are created. Is this a bug or am I missing something?Thanks,E.

201
William Bishop
Mironeer
S
Stephane BARIZIENNew Here
asked in Developer platform and APIs
Bi-directional link between Miro Mind Map and Jira

I’m investigating the possibility to create (e.g., via PowerShell code leveraging the Miro REST API) a bidirectional link between a Miro Mind Map and Jira tickets.This would need adding a custom “Jira ticket ID” property to each of the nodes in the Miro Mind Map.I’m trying to use the PATCH method on a mindmap_node, but this doesn’t seem to be supported (“Operation not supported”, status 400).Have a hit a dead end (Custom attributes for Mindmap node | Miro is 2 years old, maybe this is now possible)? 

962
E
William Bishop
Mironeer
William BishopMironeer
posted in Developer platform and APIs
New in the REST API: Experimental support for Mind Maps (Create, Read, Delete)

Hey, everyone!We’re excited to announce experimental support for creating, reading, and deleting Mind Maps via the REST API. Important!Mind Maps are not yet supported in production endpoints. You can use the experimental endpoint to explore these APIs.Ready to get started? Check out our API Reference here.Changelog entry:https://developers.miro.com/changelog/2023-11-3-changelog  P.S., have feedback for us? Please share any and all of your feedback with us here in the thread below, or in the #experimental channel on our Discord server. 😎

2914
E
E
Egor KraevBeginner
posted in Developer platform and APIs
Is it not possible to generate a permanent API token for use in scripts?

I want to read and manipulate mind maps using the miro_api package, and the only way to authenticate appears to be through OAuth, and using that for development a local machine is a royal pain.Why am I forced to do the OAuth song and dance to authenticate? Most other platforms, such as Linear and Confluence, allow me to create an API token with a single click, and then I can just access them with a Python script, without spinning up web servers and other OAuth nonsense.Surely it should be up to me how much security I require at a given point?Or is there a way to generate a static API token, and I just couldn’t find it?

162
E
M
Mathieu RothNew Here
asked in Developer platform and APIs
Performance issues on large pages. Tried the recommendations.

Hi there!Long time user here. Description of my issue: performance is bad on my large board (currently around 1300 objects). It’s worse on Firefox than Chrome (firefox: the zoom and dezoom is really bad). Both equally are bad when it comes to adding a new object or editing text, with a serious 0.5 to 1sec freeze.I did read the thread about performance, and the possible solutions. Cleared cache, and reviewed the image sizes. For info, I do use a lot of tiny images, and made sure to flatten in small size most of them.My question is: I tried using synced groups in an attempt to lower even more the memory usage (my train of thought is: if I use one image and it’s instanced several times and synced, in theory the memory usage, or at least the bandwidth shall be only for the one image). Turn out the gains are minimal or nonexistent.At this point, I have no real solutions. Except maybe slicing parts of that board into another board, flattenning one JPG file out of it, and importing it again?…

181
Eca
Mironeer
M
Marleen KinderBeginner
posted in Developer platform and APIs
Deleted users are using their company email for their personal Miro account.

Miro seems to maintain all our old employees and associates accounts on their system even though we delete them from our company account. This is an issue for security and clarity in offboarding people. If they used their email and a password to access their account, rather than single sign in/OAuth using Google, they would still have access and not be locked out. I understand that this is not the case on the enterprise plan but in my opinion should be a feature on the basic plan too. 

81
Eca
Mironeer
K
karol931Beginner
asked in Developer platform and APIs
API App card width.

I am trying to recreate existing board to another one through the API and I have encountered a problem.It is not possible to create app card that has less than 256 width through the API.Documentation doesn’t say anything about limits and it is possible to do that on the board.

212
K
G
Guglielmo RaiolaNew Here
asked in Developer platform and APIs
Change display name

Hello team,Is it possible to change a display name where it is synced through entra? Currently have a user who wants to change their display name to their middle name.

92
Eca
Mironeer
S
Stylianos PantelakisNew Here
asked in Developer platform and APIs
Invoice

Dear all,How can I see who in our company is responsible for our Miro account? It is very important because the invoices are payed from my Kredit Card. Best RegardsStylianos Pantelakis

71
Eca
Mironeer
P
Pavel SyrnikovNew Here
asked in Developer platform and APIs
Unassigning a Card via the Miro API

Hello Miro Support Team,I am currently working with the Miro API and using the "Update card item" endpoint (PATCH https://api.miro.com/v2/boards/{board_id}/cards/{item_id}) to manage card details. My goal is to remove the current assignee from a card. However, I have tried setting the assigneeId to null, an empty string, and even omitting the field entirely, but none of these approaches seem to unassign the card.Could you please advise if there is a supported method for unassigning a card via the API? If not, is there a planned update to allow this functionality? Any guidance or workaround you can provide would be greatly appreciated.Thank you for your help.Best regards,Syrnikov Pavel

242
P
O
OlehContributor
asked in Developer platform and APIs
App icon disappears from app list after page reload

Hi guys!I have strange behavior with my app so maybe someone can help me.I installed the app in user settings and see app icon in app list on my board. I open the app and got authenticated. After that I can work with the app BUT after page reloading the app icon disappears from the app list on my board. What it can be ? Is there something wrong with my app or it’s OK because it’s not published in market? Now it’s deployed on Vercel. 

608
O
A
Anna VasNew Here
asked in Developer platform and APIs
URGENTLY!!!!! my personal board disappeared how did i leave the group

In the upper left corner there are groups, and it turns out I was a member there. I created my boards, and I always got an error that I had overcome the barrier in editing 3 boards. I did not understand why this was happening. I saw that I was in some group and clicked to delete from there .... and I saw how my boards disappeared ... shock, tears. I do not even remember who else was in this group and who was its administrator. I send requests to edit my board (I found its link), but I only receive a notification that my access was sent to the owner ... Which owner? if I was the owner? how can I now find out who my access depends on? and who can give me access to this group again? how can I find the history of my board? can someone from tech support help me restore my access, since I do not even know who to contact ... and these are very important boards for me !!!!!!!!!!!!!!

484
Robert Johnson
L
Laurent AmoravainNew Here
asked in Developer platform and APIs
Pagination configuration miro > n8n

Hey,I'm trying to configure Pagination for a Miro node in n8n but I definitely cannot make it work.I only receive the first 10 results. I read all the other topic on the community but I can’t figure it oufI receive this information in the response :I try to configure it this way but I still only receive first 10 results : Am i doing something wrong ?Thanks a lot for your help,Laurent

170
L
S
SnezhanaNew Here
asked in Developer platform and APIs
the technical error

I have the free subscription, but I use only 1 board and still I’m not able t o use it. the program is telling me that I’m out of limit, which is not true. Please, fix it! 

121
Robert Johnson
Terms & Conditions