Skip to main content
GET
/
mindmap
/
getMindMap
/
{mindmapId}
Get Mind Map by ID
curl --request GET \
  --url https://api.example.com/mindmap/getMindMap/{mindmapId} \
  --header 'api-key: <api-key>'
{
  "_id": "65f5...",
  "orgId": "65f1c0f5a2b3c4d5e6f7a8b9",
  "userId": "user-123",
  "mindmapName": "Algebra Concepts Map",
  "nodes": [
    {
      "id": "node1",
      "label": "Algebra",
      "positionX": "0",
      "positionY": "0",
      "definition": "Branch of mathematics dealing with symbols and rules",
      "isHighlyImportant": true
    }
  ],
  "edges": [
    {
      "id": "edge1",
      "source": "node1",
      "target": "node2"
    }
  ],
  "createdAt": "2024-03-12T10:00:00.000Z",
  "updatedAt": "2024-03-12T10:00:00.000Z"
}

​
Description

This endpoint retrieves the details of a specific mind map using its unique mindmapId. It returns all information about the mind map, including its nodes, edges, and metadata. Use this endpoint to fetch mind map data for visualization, study, or further processing in your application.

​
Example Request

curl -X GET \
  'https://b2b-api-backend-95487.ondigitalocean.app/mindmap/getMindMap/{mindmapId}' \
  -H 'accept: application/json' \
  -H 'api-key: <your-api-key>'

​
Example Value

{
  "_id": "65f5...",
  "orgId": "65f1c0f5a2b3c4d5e6f7a8b9",
  "userId": "user-123",
  "mindmapName": "Algebra Concepts Map",
  "nodes": [
    {
      "id": "node1",
      "label": "Algebra",
      "positionX": "0",
      "positionY": "0",
      "definition": "Branch of mathematics dealing with symbols and rules",
      "isHighlyImportant": true
    }
  ],
  "edges": [
    {
      "id": "edge1",
      "source": "node1",
      "target": "node2"
    }
  ],
  "createdAt": "2024-03-12T10:00:00.000Z",
  "updatedAt": "2024-03-12T10:00:00.000Z"
}

​
Authentication

​
api-key
string
required
Your organisation’s API key

​
Path Parameters

​
mindmapId
string
required
The ID of the mind map to retrieve

​
Response

​
_id
string
MongoDB ObjectId of the mind map
​
orgId
string
Organisation ID
​
userId
string
User identifier
​
mindmapName
string
Name of the mind map
​
nodes
array
Array of mind map nodes
​
edges
array
Array of connections between nodes
​
createdAt
string
Timestamp of creation
​
updatedAt
string
Timestamp of last update
{
  "_id": "65f5...",
  "orgId": "65f1c0f5a2b3c4d5e6f7a8b9",
  "userId": "user-123",
  "mindmapName": "Algebra Concepts Map",
  "nodes": [
    {
      "id": "node1",
      "label": "Algebra",
      "positionX": "0",
      "positionY": "0",
      "definition": "Branch of mathematics dealing with symbols and rules",
      "isHighlyImportant": true
    }
  ],
  "edges": [
    {
      "id": "edge1",
      "source": "node1",
      "target": "node2"
    }
  ],
  "createdAt": "2024-03-12T10:00:00.000Z",
  "updatedAt": "2024-03-12T10:00:00.000Z"
}