Skip to main content

New in the REST API: Experimental support for Mind Maps (Create, Read, Delete)


William Bishop
Mironeer
Forum|alt.badge.img+4

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. 😎

Was it helpful?

4 replies

Forum|alt.badge.img

I believe there is something wrong with the endpoint, I’m using the “Try it” from the documentation and I get:

 

​​​​​​​{
  "type": "error",
  "code": "2.0703",
  "context": {
    "fields": [
      {
        "field": "geometry.height",
        "message": "Field [geometry.height] is not supported"
      }
    ]
  },
  "message": "Invalid parameters",
  "status": 400
}

 


William Bishop
Mironeer
Forum|alt.badge.img+4
  • Author
  • Mironeer
  • 240 replies
  • September 9, 2024

Hi @Junior Godoi,

Thank you for bringing this to our attention!

At the moment, I believe it’s only possible to specify the width for a node when creating via API, and it will be autoscaled based on this. If you leave the height field empty, the request should work.

We will confirm this with our team and update the documentation accordingly to reflect this. Thanks again for sharing this with us.

Best,
Will


Forum|alt.badge.img
  • Beginner
  • 4 replies
  • February 11, 2025

Hey there! Any idea when this will be deployed in production? Happy to help test :-)


Forum|alt.badge.img+1
  • Beginner
  • 3 replies
  • April 13, 2025

@William Bishop Thanks a lot for this!

I’m trying to get a two-way sync between Miro mind maps and Linear (as Linear’s unlimited sub-issue depth is pretty much equivalent to mind maps)
Trying to use it now through the Python wrapper (could also use REST API directly from Python if that allows me to do more), and have some questions:

  1. What values are allowed in the additional_properties of the MindmapCreateRequest? It would be very handy to be able to store arbitrary metadata there, but now for example it tells me “field ‘description’ is not supported”
  2. The nodes created via the API don’t appear to be affected when I toggle auto-layout or choose “Layout nodes”, they stay where they are - that is a shame as auto-layout would be a very handy way to organize them visually once they’ve been created. Even better would be to have an “auto” option for both geometry and position, which would behave just like the UI auto-layout and choose the geometry just large enough for the text
  3. Can you please add a “modify node” endpoint to the REST API? Right now, the only way I can think of doing that is deleting the node, and then manually creating a new one, and restoring all of its children and parent relationships - doable but a pain
  4. Are there any plans to add dotted links between nodes in different mind map branches? I don’t see it at all in the node creation API, and while it’s possible to “add link” in the UI (so the data model etc is there), it’s not rendered as a dotted arrow on the mind map, and thus kinda defies the purpose.
  5. Would be totally awesome to have an ability to insert more text into a float-on-hover (tooltip-like), so I can have more information 

Reply