API Calls

Last updated
Save as PDF

Reference API methods and call examples to use the MindTouch API.

This API calls guide is out of date. API endpoint documentation currently under migration to the API Reference guide.

archive API calls
This page contains a list of all the API methods in the "Archive" category.
contextmaps
This page contains a list of all the API methods in the "Contextmaps" category.
contexts
This page contains a list of all the API methods in the "Contexts" category.
events API calls
The Events methods provide access to all the different user event logs in MindTouch. You can use the events methods to retrieve the site wide activity, retrieve the activity of a specific page, and more.
files API calls
Use the Files methods to update file attachments, copy files, move files, edit file properties and more. Files can be attached to one Page but used in many pages. Files inherit the permissions of the page they are attached to so if you attach a file to a private page, it will require user grants to access it. The text in certain file types such as .pdf, docx and others are indexed by the MindTouch search engine and will show up in the MindTouch search results.
groups API calls
This page contains a list of all the API methods in the "Groups" category.
pages API calls
Use the Pages methods to retrieve a list of all MindTouch pages, retrieve individual pages, update existing pages, move pages, rate pages, view page revisions, add tags to pages and more. Each MindTouch page has a unique ID that can be used in the API call to access all of the page properties.
site API calls
The Site methods allow you access all of the site wide data and configurations. You may use the site method to conduct a search, retrieve a list of pages with a specific tag, post feedback, retrieve a list of user search queries and more.
users API calls
The Users methods can be used to create new users, retrieve user page subscriptions, authenticate users and more. In MindTouch, users are separated into three categories: Anonymous - Not authenticated Community Members - Authenticated user without a license. Community members can read, favorite, comment and rate but cannot edit pages. Pro-Members (aka seated) - Authenticated user with a license. Pro-Members can be assigned a role of Viewer, Author, Editor or Admin. Each role has different capabilities ranging from editing pages to accessing the control panel.