MEmendix
Projects

Get project details

Returns full details of a single project.</br>Every request must be authenticated by a Personal Access Token containing the scope mx:app:metadata:read. Deactivated projects will only be returned for Mendix Administrators.

get/projects/{project-id}

Request

  • Base URL
    https://projects-api.home.mendix.com/v2
  • Auth
    API key in header Authorization

Path parameters

project-idstring required

The unique identifier of a project

Response

Project details

projectIdstring uuid

Unique identifier in the Mendix Platform.

namestring

Name of the project.

descriptionstring

Description of the project.

logostring

URL of the project image/logo.

createdOnstring

Date and time when the project was created, expressed in UTC.

activeboolean

Indicates whether a project is active or not. Inactive projects will only be returned to Mendix Admins.

versionStudioProstring

The Studio Pro version of the main branch of the project. Please note that this value could be empty or not up to date if the changes are not committed through Studio Pro.

storyTool'Epics' | 'Jira'

The tool or service used to manage the workload of the project. Can be empty if no tool has been chosen yet.

storyBoardUrlstring

Location of the story board used to manage the workload of the project

cloudProvider'Mendix' | 'SAP' | 'STACKIT' | 'Mendix_for_Private_Cloud'

Cloud deployment provider (Public Mendix, Private Mendix, SAP, on-prem, etc)

targetCloudstring

URL of the cloud portal where the project is hosted

Changes

No recorded changes to this operation across all 1 revision of this API.