MEmendix
projects

Get a project with project Id

Get a project details with project Id

get/projects/{projectId}

Request

  • Base URL
    https://pmp-demo.privateplatform.mendix.com/projectservice/v2
  • Auth
    • HTTP basic
    • or API key in header Authorization

Path parameters

projectIdstring required

Project Id

Query parameters

status'Active' | 'Archived'

Get active project or archived project with project Id

Response

Project

idstring

Project id.

namestring

Project name.

descriptionstring

Project description.

ownerUserNamestring

Project owner's username.

ownerGroupNamestring

Project owner's group name.

memberCountinteger

Number of members in the project.

repositoryIdstring

Repository id.

repositoryNamestring

Repository name.

repositoryURLstring

Repository URL.

isActiveboolean

Indicates if the project is active.

createdDatestring

Date when the project was created.

Example response

{
  "id": "d8e4086c-8a5c-4372-9781-03a83c87defb",
  "name": "App-test-1",
  "description": "This project was created by Mendix Studio Pro.",
  "ownerUserName": "Peter",
  "ownerGroupName": "IT",
  "memberCount": 2,
  "repositoryId": "172",
  "repositoryName": "App-test-1",
  "repositoryURL": "https://gitlab.com/lato/App-test-1.git",
  "isActive": true,
  "createdDate": "2023-08-13T06:06:55.196Z"
}

Changes

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