Private Mendix Platform Group API - Version 2
Last modified: July 3, 2026
This document is about Private Mendix Platform API. This API is only available on instances of Private Mendix Platform. For Mendix on Kubernetes API, see Mendix on Kubernetes Build API and Mendix on Kubernetes Deploy API.
Introduction
The Private Mendix Platform Group API version 2 allows you to manage user groups in Private Mendix Platform. You can use the API to do the following:
- Get a group by ID.
- Get a list of all groups for the current user.
- Create, update, or delete a group.
- Retrieve a list of all users in a group.
- Update group member roles.
- Add or remove members from a group.
- Retrieve all cluster namespaces assigned to a group.
- Assign a cluster namespace to a group.
- Update the deployment purpose of cluster namespace.
- Remove cluster namespaces from the group.
For information about Group API version 1, see Group API - Version 1.