Projects API

Last modified: July 9, 2025

Introduction

The Mendix Projects API allows you to create, edit or delete your projects. It also allows you to manage members of those projects and assign project roles, such as Scrum Master.

If you want to automate the process of assigning the more coarse-grained Mendix Admin role, you can do so by configuring Single Sign-On (SSO) to the platform (also known as BYOIdP) and enabling the IdP-managed Mendix Admins feature.

Authentication

Authentication for the Projects API uses a personal access token (PAT).

Generating a PAT

For details on how to generate a PAT, see the Personal Access Tokens section of User Settings.

Select the appropriate scopes, depending on the endpoints that need to be invoked. Refer to the API Reference for more information on which scopes to use in which endpoints.

Store the generated value somewhere safe so you can use it to authorize your API calls.

Using the PAT

Each request must contain an Authorization header with the value MxToken {GENERATED_PAT}. For example:

GET /projects HTTP/1.1
Authorization: MxToken 7LJE…vk

API Reference

You cannot call endpoints in the Swagger UI below on this page.