MindMeister API

https://www.mindmeister.com/developers
Admin
MindMeister API enables developers to create applications that interact with MindMeister's mind...
Tokens:10,847
Snippets:123
Trust Score:10
Update:6 months ago
Show doc for...
Tokens:
Raw
### API Response Examples

Source: https://www.mindmeister.com/developers/introduction

Examples of successful and failed API response structures.

```xml
<rsp stat="ok">
                       <api_key>123456789DEADBEEF</api_key>
                       <foo>bar</foo>
                       <method>mm.test.echo</method>
                    </rsp>
```

```xml
<rsp stat="fail">
                           <err code="112" msg="Method "mm.test.abracadarba" not found"/>
                        </rsp>
```

--------------------------------

### Make a GET Request to the MindMeister API

Source: https://www.mindmeister.com/developers/introduction?locale=en

Example of how to invoke the mm.test.echo service using a GET request. Ensure you replace placeholder values with your actual API key and desired parameters.

```http
http://www.mindmeister.com/services/rest/?**method**=**mm.test.echo**&  
**api_key**=**123456789DEADBEEF**&**name**=**value**
```

--------------------------------

### MindMeister API Successful Response Example

Source: https://www.mindmeister.com/developers/introduction?locale=en

This is an example of a successful response from the MindMeister API. It includes the API key, a custom parameter, and the method called.

```xml
<?xml version="1.0" encoding="UTF-8"?>
                    <rsp stat="ok">
                       <api_key>123456789DEADBEEF</api_key>
                       <foo>bar</foo>
                       <method>mm.test.echo</method>
                    </rsp>
```

--------------------------------

### Desktop Application Authentication - Get Frob

Source: https://www.mindmeister.com/developers/authentication?locale=nl

For desktop applications, first call 'mm.auth.getFrob' to obtain a frob value, which is then used in the authentication URL.

```xml
<rsp stat="ok">
                <frob>123456</frob>
                </rsp>
```

--------------------------------

### Obtaining Authentication Token

Source: https://www.mindmeister.com/developers/authentication?locale=zh

After user authorization, call `mm.auth.getToken` with the `frob` to get an authentication token for subsequent API calls.

```APIDOC
## Obtaining Authentication Token

After a user authorizes your application, make a call to `mm.auth.getToken` with the `frob` parameter.

**Example Request (Conceptual):**
`POST /services/rest/?method=mm.auth.getToken&api_key=...&frob=...&api_sig=...`

**Example Response:**
```xml
<rsp stat="ok">
    <auth>
        <token>410c57262293e9d937ee5be75eb7b0128fd61b61</token>
        <perms>delete</perms>
        <user id="1" username="till_vollmer" fullname="Till Vollmer" />
    </auth>
</rsp>
```

The `<token>` is your `auth_token` for future authenticated API calls.
```

--------------------------------

### MindMeister API Failure Response Example

Source: https://www.mindmeister.com/developers/introduction?locale=en

This is an example of a failure response from the MindMeister API, indicating that a requested method was not found.

```xml
<rsp stat="fail">
                           <err code="112" msg="Method "mm.test.abracadarba" not found"/>
                        </rsp>
```

--------------------------------

### GET mm.auth.checkToken

Source: https://www.mindmeister.com/developers/authentication

Verifies the validity of an existing authentication token.

```APIDOC
## GET mm.auth.checkToken

### Description
Checks if the provided auth_token is still valid.

### Parameters
#### Query Parameters
- **auth_token** (string) - Required - The token to verify

### Response
#### Success Response (200)
- **token** (string) - The authentication token
- **perms** (string) - Permissions granted
- **user** (object) - User information

#### Error Response (Fail)
- **code** (integer) - Error code
- **msg** (string) - Error message

#### Response Example
<rsp stat="ok">
  <auth>
    <token>410c57262293e9d937ee5be75eb7b0128fd61b61</token>
    <perms>delete</perms>
    <user id="1" username="till_vollmer" fullname="Till Vollmer" />
  </auth>
</rsp>
```

--------------------------------

### GET mm.auth.checkToken

Source: https://www.mindmeister.com/developers/authentication?locale=en

Verifies the validity of an existing authentication token.

```APIDOC
## GET mm.auth.checkToken

### Description
Checks if the provided auth_token is still valid. If the token has expired or is invalid, an error is returned.

### Parameters
#### Query Parameters
- **auth_token** (string) - Required - The authentication token to verify

### Response
#### Success Response (200)
- **token** (string) - The authentication token
- **perms** (string) - Permissions granted
- **user** (object) - User information

#### Error Response (200)
- **err** (object) - Contains error code and message if token is invalid

#### Response Example
<rsp stat="fail">
  <err code="98" msg="Login failed / Invalid auth token" />
</rsp>
```

--------------------------------

### MindMeister REST API Endpoint

Source: https://www.mindmeister.com/developers/introduction?locale=en

The base URL for the MindMeister REST API. Requests can be made using HTTP GET or POST.

```APIDOC
## MindMeister REST API

### Description
The MindMeister REST API allows you to perform actions by sending requests to specific endpoints. All requests require a `method` and `api_key` parameter.

### Base URL
`http://www.mindmeister.com/services/rest/`
`https://www.mindmeister.com/services/rest/` (HTTPS)

### Method
GET or POST

### Parameters
#### Query Parameters
- **method** (string) - Required - The specific API method to call.
- **api_key** (string) - Required - Your unique API key for authentication.
- **name** (string) - Optional - Example parameter for the `mm.test.echo` method.
- **value** (string) - Optional - Example parameter for the `mm.test.echo` method.

### Request Example (mm.test.echo)
```
http://www.mindmeister.com/services/rest/?**method**=**mm.test.echo**&**api_key**=**123456789DEADBEEF**&**name**=**value**
```

### Response Format
Responses are returned in XML format.

#### Success Response Example
```xml
<?xml version="1.0" encoding="UTF-8"?>
<rsp stat="ok">
   <api_key>123456789DEADBEEF</api_key>
   <foo>bar</foo>
   <method>mm.test.echo</method>
</rsp>
```

#### Failure Response Example
```xml
<?xml version="1.0" encoding="UTF-8"?>
<rsp stat="fail">
   <err code="112" msg="Method "mm.test.abracadarba" not found"/>
</rsp>
```

### Conventions
**Encodings**: All strings are UTF-8 encoded.
**Date and Time formats**: All times are in UTC. The format is YYYY-MM-DD HH:MM:SS. Example: 2007-12-31 23:11:00

### Special Cases
**Importing Maps**: The `mm.maps.import` request must be a multipart mixed POST request. The file content is not part of the signature and this call cannot be tested via the method explorer (uses HTTP GET).
**Exporting Maps**: The `mm.maps.export` request returns a list of URLs for exporting maps in different formats. Private maps require signing and authentication.
```

--------------------------------

### Construct Desktop Authentication URL

Source: https://www.mindmeister.com/developers/authentication?locale=nl

Build the authentication URL for desktop applications, including API key, permissions, frob, and the calculated signature.

```text
http://www.mindmeister.com/services/auth/
```

```text
http://www.mindmeister.com/services/auth/?api_key=abc123
```

```text
http://www.mindmeister.com/services/auth/?api_key=abc123&perms=delete
```

```text
http://www.mindmeister.com/services/auth/?api_key=abc123&perms=delete&frob=123456
```

```text
http://www.mindmeister.com/services/auth/?api_key=abc123&perms=delete&frob=123456&api_sig=zxy987
```

--------------------------------

### Construct Desktop Authentication URL

Source: https://www.mindmeister.com/developers/authentication?locale=de

Build the authentication URL for desktop applications, including API key, permissions, frob, and the calculated signature.

```text
http://www.mindmeister.com/services/auth/?api_key=abc123&perms=delete&frob=123456&api_sig=zxy987
```

--------------------------------

### Construct Desktop Authentication URL

Source: https://www.mindmeister.com/developers/authentication?locale=fr

Building a URL for desktop applications, requiring an initial frob retrieval and inclusion in the authentication request.

```xml
<rsp stat="ok">
                <frob>123456</frob>
                </rsp>
```

```text
http://www.mindmeister.com/services/auth/
```

```text
http://www.mindmeister.com/services/auth/?api_key=abc123
```

```text
http://www.mindmeister.com/services/auth/?api_key=abc123&perms=delete
```

```text
http://www.mindmeister.com/services/auth/?api_key=abc123&perms=delete&frob=123456
```

```text
http://www.mindmeister.com/services/auth/?api_key=abc123&perms=delete&frob=123456&api_sig=zxy987
```

--------------------------------

### User Authentication for Desktop Applications

Source: https://www.mindmeister.com/developers/authentication?locale=zh

Process for authenticating users in desktop applications, involving `mm.auth.getFrob` and constructing an authentication URL.

```APIDOC
## User Authentication for Desktop Applications

1. Call `mm.auth.getFrob` to obtain a `frob` value.
   Example Response:
   ```xml
   <rsp stat="ok">
       <frob>123456</frob>
   </rsp>
   ```
2. Construct an authentication URL:
   a. Start with the authentication service URL: `http://www.mindmeister.com/services/auth/`
   b. Append your `api_key`.
   c. Append a `perms` parameter.
   d. Append the `frob` obtained in step 1.
   e. Sign the parameters and append `api_sig`.

   **Example URL:**
   `http://www.mindmeister.com/services/auth/?api_key=abc123&perms=delete&frob=123456&api_sig=zxy987`

   **Valid `perms` values:**
   * `read`: Read task, contact, group, and list details.
   * `write`: Add and modify task, contact, group, and list details (includes `read`).
   * `delete`: Delete tasks, contacts, groups, and lists (includes `read` and `write`).
```

--------------------------------

### Construct Web Authentication URL

Source: https://www.mindmeister.com/developers/authentication?locale=fr

Building a URL for web-based application authentication by appending API key, permissions, and the signature.

```text
http://www.mindmeister.com/services/auth/
```

```text
http://www.mindmeister.com/services/auth/?api_key=abc123
```

```text
http://www.mindmeister.com/services/auth/?api_key=abc123&perms=delete
```

```text
http://www.mindmeister.com/services/auth/?api_key=abc123&perms=delete&api_sig=zxy987
```

--------------------------------

### Construct String for Signing

Source: https://www.mindmeister.com/developers/authentication?locale=nl

Concatenate all sorted key/value pairs into a single string to be used for MD5 hashing.

```text
abcbazfegbaryxzfoo
```

--------------------------------

### Sort Parameters for Signing

Source: https://www.mindmeister.com/developers/authentication?locale=de

Parameters must be sorted alphabetically by key name before constructing the string for signing.

```text
yxz=foo feg=bar abc=baz

becomes:

abc=baz feg=bar yxz=foo
```

--------------------------------

### Sort Parameters for Signing

Source: https://www.mindmeister.com/developers/authentication?locale=nl

Parameters must be sorted alphabetically by key name before constructing the string for signing.

```text
yxz=foo feg=bar abc=baz
```

```text
abc=baz feg=bar yxz=foo
```

--------------------------------

### Sign API Request Parameters

Source: https://www.mindmeister.com/developers/authentication?locale=fr

Steps to sort parameters, concatenate them with a shared secret, and generate an MD5 signature.

```text
yxz=foo feg=bar abc=baz
```

```text
abc=baz feg=bar yxz=foo
```

```text
abcbazfegbaryxzfoo
```

```text
**DEADBEEF**abcbazfegbaryxzfoo
```

```text
md5('DEADBEEFabcbazfegbaryxzfoo') -> 75178b3c27252027ae97b9a5eb36ce41
```

--------------------------------

### POST mm.auth.getToken

Source: https://www.mindmeister.com/developers/authentication?locale=en

Exchanges a frob for an authentication token to be used in subsequent API calls.

```APIDOC
## POST mm.auth.getToken

### Description
Exchanges a frob obtained from mm.auth.getFrob for an auth_token used for authenticated API requests.

### Parameters
#### Query Parameters
- **frob** (string) - Required - The frob received from mm.auth.getFrob

### Response
#### Success Response (200)
- **token** (string) - The authentication token
- **perms** (string) - Permissions granted
- **user** (object) - User information including id, username, and fullname

#### Response Example
<rsp stat="ok">
  <auth>
    <token>410c57262293e9d937ee5be75eb7b0128fd61b61</token>
    <perms>delete</perms>
    <user id="1" username="till_vollmer" fullname="Till Vollmer" />
  </auth>
</rsp>
```

--------------------------------

### POST mm.auth.getToken

Source: https://www.mindmeister.com/developers/authentication

Exchanges a frob for an authentication token to be used in subsequent API calls.

```APIDOC
## POST mm.auth.getToken

### Description
Exchanges a frob obtained from mm.auth.getFrob for an auth_token used for authenticated API calls.

### Parameters
#### Query Parameters
- **frob** (string) - Required - The frob received from mm.auth.getFrob

### Response
#### Success Response (200)
- **token** (string) - The authentication token
- **perms** (string) - Permissions granted
- **user** (object) - User information including id, username, and fullname

#### Response Example
<rsp stat="ok">
  <auth>
    <token>410c57262293e9d937ee5be75eb7b0128fd61b61</token>
    <perms>delete</perms>
    <user id="1" username="till_vollmer" fullname="Till Vollmer" />
  </auth>
</rsp>
```

--------------------------------

### Calculate MD5 Hash for Signing

Source: https://www.mindmeister.com/developers/authentication?locale=nl

Prepend the shared secret to the concatenated parameter string and calculate the MD5 hash. This hash is used as the 'api_sig' parameter.

```text
md5('DEADBEEFabcbazfegbaryxzfoo') -> 75178b3c27252027ae97b9a5eb36ce41
```

--------------------------------

### Retrieving Authentication Token

Source: https://www.mindmeister.com/developers/authentication?locale=ja

Response format after calling mm.auth.getToken to finalize authorization.

```xml
<rsp stat="ok">
                <auth>
                <token>410c57262293e9d937ee5be75eb7b0128fd61b61</token>
                <perms>delete</perms>
                <user id="1" username="till_vollmer" fullname="Till Vollmer" />
                </auth>
                </rsp>
```

--------------------------------

### POST /embed

Source: https://www.mindmeister.com/developers/embed

Endpoint for initializing and configuring a mind map embed session.

```APIDOC
## POST /embed

### Description
Initializes a mind map in the editor with specific configuration parameters for display and save behavior.

### Method
POST

### Parameters
#### Request Body
- **api_key** (string) - Required - Your developer API key
- **file[id]** (integer) - Optional - Unique identifier for the file
- **file[name]** (string) - Optional - File name including extension
- **file[allow_export]** (boolean) - Optional - Enables/disables export and print functionality
- **file[view_only]** (boolean) - Optional - Displays map in view-only mode
- **file[hide_close_button]** (boolean) - Optional - Hides the close button
- **file[hide_sidebar]** (boolean) - Optional - Shows sidebar in minimized state
- **file[use_url_params]** (boolean) - Optional - Uses exact newcopy_url or overwrite_url
- **file[indexable_text]** (boolean) - Optional - Saves a .txt file with indexable text
- **file[download_url]** (string) - Optional - URL to fetch the file content
- **file[content]** (multipart/form-data) - Optional - The file content
- **file[save_action]** (string) - Optional - 'o' for overwrite or 's' for save as new copy
- **file[newcopy_url]** (string) - Optional - URL to post map when saving as new copy
- **file[overwrite_url]** (string) - Optional - URL to post map when overwriting
- **file[success_url]** (string) - Optional - URL to redirect after closing
- **external_user_name** (string) - Optional - Name of the user editing the map
```

--------------------------------

### GET/POST /services/rest/

Source: https://www.mindmeister.com/developers/introduction

The primary endpoint for interacting with the MindMeister service. All API methods are invoked by specifying the method name and providing the required API key.

```APIDOC
## GET/POST /services/rest/

### Description
Executes a specific MindMeister API method. The request must include the method name and a valid API key.

### Method
GET or POST

### Endpoint
https://www.mindmeister.com/services/rest/

### Parameters
#### Query Parameters
- **method** (string) - Required - The name of the API method to call (e.g., mm.test.echo).
- **api_key** (string) - Required - Your unique API key.

### Request Example
http://www.mindmeister.com/services/rest/?method=mm.test.echo&api_key=123456789DEADBEEF&name=value

### Response
#### Success Response (200)
- **stat** (string) - Status of the request, returns 'ok' on success.
- **api_key** (string) - The API key used for the request.
- **method** (string) - The method that was executed.

#### Response Example
<rsp stat="ok">
   <api_key>123456789DEADBEEF</api_key>
   <foo>bar</foo>
   <method>mm.test.echo</method>
</rsp>

#### Failure Response
- **stat** (string) - Status of the request, returns 'fail' on error.
- **err** (object) - Contains error code and message.

#### Error Example
<rsp stat="fail">
   <err code="112" msg="Method 'mm.test.abracadarba' not found"/>
</rsp>
```

--------------------------------

### User Authentication for Web Applications

Source: https://www.mindmeister.com/developers/authentication?locale=zh

Flow for authenticating users in web applications by constructing a specific authentication URL.

```APIDOC
## User Authentication for Web Applications

Construct an authentication URL to authenticate users:

1. Start with the authentication service URL: `http://www.mindmeister.com/services/auth/`
2. Append your `api_key`.
3. Append a `perms` parameter (e.g., `read`, `write`, `delete`).
4. Sign the parameters as described in 'Signing Requests' and append `api_sig`.

**Example URL:**
`http://www.mindmeister.com/services/auth/?api_key=abc123&perms=delete&api_sig=zxy987`

**Valid `perms` values:**
* `read`: Read task, contact, group, and list details.
* `write`: Add and modify task, contact, group, and list details (includes `read`).
* `delete`: Delete tasks, contacts, groups, and lists (includes `read` and `write`).
```

--------------------------------

### Signing Requests

Source: https://www.mindmeister.com/developers/authentication?locale=zh

Details on how to sign API requests using your shared secret by sorting parameters, concatenating them with the secret, and calculating an MD5 hash.

```APIDOC
## Signing Requests

To sign a request:
1. Sort your parameters by key name alphabetically.
2. Concatenate all key-value pairs into a single string.
3. Prepend your shared secret to this string.
4. Calculate the MD5 hash of the resulting string.
5. Use this hash as the `api_sig` parameter.

**Example:**
Shared Secret: `DEADBEEF`
Parameters: `yxz=foo feg=bar abc=baz`

Sorted Parameters: `abc=baz feg=bar yxz=foo`
Concatenated String: `abcbazfegbaryxzfoo`
String with Secret: `DEADBEEFabcbazfegbaryxzfoo`
MD5 Hash (api_sig): `75178b3c27252027ae97b9a5eb36ce41`
```

--------------------------------

### Embed Map Editor via HTML Form

Source: https://www.mindmeister.com/developers/embed?locale=de

Use this HTML form to initiate a POST request to the MindMeister editor. Ensure the file input supports the required map formats like .mind, .mmap, .mm, or .xmind.

```html
<form action="https://www.mindmeister.com/external/show"  
 target="new" method="POST"
enctype="multipart/form-data">
MindMeister File: <input type="file" name="file[content]"/>
Id: <input type="text" name="file[id]" value="-1"/>
Name: <input type="text" name="file[name]" value="some map"/>
API Key: <input type="text" name="api_key" value="your_api_key"/>
Allow export: <input type="checkbox" name="file[allow_export]" />
</form>
```

--------------------------------

### XML Response Header

Source: https://www.mindmeister.com/developers/introduction

The standard XML declaration included in API responses.

```xml
<?xml version="1.0" encoding="UTF-8"?>
```

--------------------------------

### HTTPS REST Endpoint

Source: https://www.mindmeister.com/developers/introduction

The secure base URL for all API requests.

```text
https://www.mindmeister.com/services/rest/
```

--------------------------------

### MindMeister Embedding API Parameters

Source: https://www.mindmeister.com/developers/embed?locale=en

This section details the parameters available for embedding and managing mind maps via the MindMeister API.

```APIDOC
## POST /websites/mindmeister_developers

### Description
This endpoint allows for embedding and managing mind maps using various parameters to control file handling, export options, and user interactions.

### Method
POST

### Endpoint
/websites/mindmeister_developers

### Parameters
#### Query Parameters
- **api_key** (string) - Required - Your developer API key.

#### Request Body
- **file[id]** (integer) - Optional - Unique identifier for the file.
- **file[name]** (string) - Required - File name, including the extension. If '.mind_simple' is used, `file[content]` can contain JSON map data.
- **file[allow_export]** (boolean) - Optional - Flag to enable/disable export and print functionality.
- **file[view_only]** (boolean) - Optional - If true, the map is displayed in view-only mode.
- **file[hide_close_button]** (boolean) - Optional - If true, hides the close button on the map view.
- **file[hide_sidebar]** (boolean) - Optional - If true, shows the sidebar in its minimized state.
- **file[use_url_params]** (boolean) - Optional - If true, uses `newcopy_url` or `overwrite_url` directly instead of parameters within the POST data.
- **file[indexable_text]** (boolean) - Optional - If true, saves a .txt file containing the indexable text of the mind map.
- **file[download_url]** (string) - Optional - URL to fetch the file if stored on your server, instead of using multipart upload.
- **file[content]** (file) - Optional - The file content, sent as multipart/form-data. Used if `file[name]` has '.mind_simple' extension and contains JSON.
- **file[save_action]** (string) - Optional - Determines save behavior: 'o' for overwrite, 's' for save as new copy.
- **file[newcopy_url]** (string) - Optional - URL to post the resulting map when 'Save as new copy' is used.
- **file[overwrite_url]** (string) - Optional - URL to post the resulting map when 'Overwrite' is used.
- **file[success_url]** (string) - Optional - URL to redirect the user after clicking the Close button.
- **external_user_name** (string) - Optional - The name of the user editing the map (first name and last name separated by a space).

### Request Example
```json
{
  "api_key": "YOUR_API_KEY",
  "file": {
    "name": "example.mind_simple",
    "content": "{\"title\": \"My Mind Map\"}",
    "allow_export": true,
    "save_action": "s",
    "newcopy_url": "http://example.com/save"
  },
  "external_user_name": "John Doe"
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the success of the operation.
- **message** (string) - A confirmation message.

#### Response Example
```json
{
  "status": "success",
  "message": "Mind map processed successfully."
}
```
```

--------------------------------

### Verify Token Validity Response

Source: https://www.mindmeister.com/developers/authentication?locale=en

The response received after calling mm.auth.checkToken, indicating whether the token is valid or expired.

```xml
<rsp stat="ok">
                <auth>
                <token>410c57262293e9d937ee5be75eb7b0128fd61b61</token>
                <perms>delete</perms>
                <user id="1" username="till_vollmer" fullname="Till Vollmer" />
                </auth>
                </rsp>
```

```xml
<rsp stat="fail">
                <err code="98" msg="Login failed / Invalid auth token" />
                </rsp>
```

--------------------------------

### API Key and Shared Secret

Source: https://www.mindmeister.com/developers/authentication?locale=zh

To use the MindMeister API, you need an API Key and a shared secret for signing requests. The API v1 is deprecated.

```APIDOC
## API Key and Shared Secret

API v1 is deprecated. Please use API v2.

To authenticate, you need an API Key and a shared secret. The shared secret is used to sign requests.
```
Tokens:
Raw