Last update: Download PDF Edit

API Keys

Most Mendix Platform APIs require their users to authenticate themselves; this is done by using API keys. You can obtain a Mendix API key as follows:

  1. Navigate to the
  2. Open your profile. You can do this by clicking on your avatar in the top right corner of the screen and clicking Show Profile.
  3. Switch to the API Keys tab.
  4. Click on Create new API key and follow the instructions. Note that the API key will only be shown once.

The obtained API key will allow apps that use it to act on behalf of the user. This implies that the app will have the same privileges as the user who created the API key.

Authentication headers

Any call to the Mendix Platform APIs should be authenticated using the following request headers:

  • Mendix-Username : Login name of the requesting user with the required privileges in the Mendix Platform.
  • Mendix-ApiKey : API key of this user.