API Documentation

Last update: Edit

1 Introduction

The API documentation is divided into the sections described below.

2 Authentication

Most Mendix Platform APIs require their users to authenticate themselves. This is done by using API keys.

Continue reading in Authentication.

3 Build API

To create and manage deployment packages using the Mendix build server, you will need information from the Team Server API as input for these API calls.

For details, see Build API.

4 Client API

Enrich the user interface of your applications by building on top of the Mendix web client APIs.

Continue on to the Client API.

5 Deploy API

With this API, you can manage application environments in the Mendix Cloud, retrieve statuses, start and stop applications, and deploy or transport new model versions to application environments. You will also have to use the Build API to create and manage deployment packages.

For details, see Deploy API.

6 Design Properties API

Learn how design properties work in Atlas UI and beyond with this API. Then, make your own custom design properties.

For details, see Design Properties API.

7 Feedback API

Use this API to build on top of the feedback management functionality of the Mendix Platform and connect your own feedback gathering tool.

For details, see Feedback API.

8 Permissions API

With this API, you can retrieve the user roles of your application users so you can grant them specific access levels to the application.

This is part of the AppCloudServices module.

For details, see Permissions API.

9 Pluggable Widgets API

This API helps you to understand pluggable widgets, how they extend app functionality, and how they can be built to interact with Mendix’s APIs.

For details, see Pluggable Widgets API.

10 Projects API

This API allows you to programmatically create an app project in your company space and move working copies between the Team Server and the Model Server.

For details, see Project API.

11 Runtime API

All the functionality and information from both the application model and Mendix Runtime is accessible via this API.

Continue on to the Runtime API.

12 Stories API

Use this API to extend the requirements and project management capabilities of the Mendix Platform, or connect third-party service management and project management tools.

For details, see Stories API.

13 Team Server API

This API enables retrieving information (branches, revisions) about application models stored in Team Server. You always access an application model via the context of an application (for more information about retrieving apps and app identities, see Deploy API).

For details, see Team Server API.

14 User Management API

Use this API to integrate your company’s user management systems with the Mendix Platform. You can then create and manage user accounts and security groups as well as define group policies for your applications.

For details, see User Management API.

15 Webhooks

Webhooks allow you to build or set up Mendix Platform connectors that subscribe to certain events on the Developer Portal.

Continue reading in Webhooks.