Get specific mind map node
GET/v2-experimental/boards/:board_id/mindmap_nodes/:item_id
Retrieves information for a specific mind map node on a board.
Required scope
boards:readRate limiting
Level 1Request
Path Parameters
Unique identifier (ID) of the board from which you want to retrieve a mind map node.
Unique identifier (ID) of the mind map node that you want to retrieve.
Responses
- 200
Mind map node retrieved
- application/json
- Schema
- Example (from schema)
Schema
- TextData
Unique identifier (ID) of an item.
data
object
Contains mind map node data, such as nodeView
or isRoot
.
nodeView
object
Contains the information about the mind map node.
Type of item used as mind map node. Currently, type
can only be equal to text
.
data
object
Contains the mind map node data, such as the item title, content, or description.
oneOf
The actual text (content) that appears in the text item.
style
object
Contains information about the node style, such as the node color or fillOpacity.
Hex value representing the color for the text within the node.
It sets the opacity level of the background fill color.
Allowed values: any number between 0.0 and 1.0 included.
If the value is 0.0, the background fill color is completely transparent or invisible. If the value is 1.0, the background fill color is completely opaque or solid. Default: 0 (transparent)
Possible values: >= 10
and <= 288
Defines the font size, in dp, for the text on the node.
Default: 14
.
Indicates whether this node is the root of the mind map.
Possible values: [start
, end
]
Indicates where this node is positioned relative to the root node. start
indicates that this node must be positioned at the start of the root node, which is either the left or top of the root node. end
indicates that this node must be positioned at the emd of the root node, which is either the right or bottom of the root node.
Date and time when the item was created.
Format: UTC, adheres to ISO 8601, includes a trailing Z offset.
createdBy
object
Contains information about the user who created the item.
Unique identifier (ID) of the user.
Indicates the type of object returned. In this case, type
returns user
.
Date and time when the item was last modified.
Format: UTC, adheres to ISO 8601, includes a trailing Z offset.
modifiedBy
object
Contains information about the user who last modified the item.
Unique identifier (ID) of the user.
Indicates the type of object returned. In this case, type
returns user
.
parent
object
Contains information about the parent frame for the item.
Unique identifier (ID) of the parent frame for the item.
links
object
Contains applicable links for the current object.
Link to obtain more information about the current object.
links
object
Contains applicable links for the item.
Link to obtain information about the child items related to the frame.
Link to obtain information about the current item.
Type of item that is returned.
style
object
Contains information about the node style, such as the widget's border color or shape type.
Hex value representing the color of the widget's border.
Possible values: [pill
, rectangle
, rounded_rectangle
, none
]
Shape type of the widget.
Possible values: >= 10
and <= 288
The same font size as in MindmapNodeStyle.
{
"id": "3074457362577955300",
"data": {
"nodeView": {
"type": "text",
"data": {},
"style": {
"color": "#1a1a1a",
"fillOpacity": "string",
"fontSize": "string"
}
},
"isRoot": true,
"direction": "start"
},
"createdAt": "2024-04-11T15:04:04.280Z",
"createdBy": {
"id": "3458764517517852417",
"type": "user"
},
"modifiedAt": "2024-04-11T15:04:04.280Z",
"modifiedBy": {
"id": "3458764517517852417",
"type": "user"
},
"parent": {
"id": "3074457362577955300",
"links": {
"self": "http://api.miro.com/v2/boards/o9J_koQspF4=/object_type/3074457349143649487"
}
},
"links": {
"related": "http://api.miro.com/v2/boards/o9J_koQspF4=/items?parent_item_id=307445734914369434&limit=10&cursor=",
"self": "http://api.miro.com/v2/boards/o9J_koQspF4=/item/3074457349143649487"
},
"type": "string",
"style": {
"nodeColor": "#1a1a1a",
"shape": "pill",
"fontSize": "string"
}
}