---
title: "Get project details"
method: GET
path: "/projects/{project-id}"
tags: ["Projects"]
---

# Get project details

`GET /projects/{project-id}`

## Request

- Base URL: `https://projects-api.home.mendix.com/v2`
- URL: `https://projects-api.home.mendix.com/v2/projects/{project-id}`
- Auth: API key in header `Authorization`

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.

## Path parameters

- `project-id` string, required

## Response `200`

Project details

- object
  - `projectId` string, uuid: Unique identifier in the Mendix Platform.
  - `name` string: Name of the project.
  - `description` string: Description of the project.
  - `logo` string: URL of the project image/logo.
  - `createdOn` string: Date and time when the project was created, expressed in UTC.
  - `active` boolean: Indicates whether a project is active or not. Inactive projects will only be returned to Mendix Admins.
  - `createdBy` object: Contains information about the person that created this project.
    - `userId` string, uuid: Unique identifier in the Mendix Platform.
    - `fullName` string: Full name of the member.
  - `versionStudioPro` string: 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.
  - `storyBoardUrl` string: 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)
  - `targetCloud` string: URL of the cloud portal where the project is hosted
  - `members` object[]: Array of members in the project. Inactive members will only be returned to Mendix Admins.
    - `userId` string, uuid: Unique identifier in the Mendix Platform.
    - `fullName` string: Full name of the member.
    - `avatarUrl` string: URL of the avatar image of the member.
    - `account` Account: Account or company that owns the resource
      - `accountId` string: Unique identifier of the account
      - `accountName` string: Name of the account
    - `isActive` boolean: Indicator of whether the member is active.
    - `role` object: Member role details
      - `roleId` string, uuid: Unique identifier in the Mendix Platform.
      - `roleName` string: Role name
  - `technicalContact` User: Details of a user.
    - `userId` string, uuid: Unique identifier in the Mendix Platform.
    - `fullName` string: Full name of the member.
    - `avatarUrl` string: URL of the avatar image of the member.
    - `account` Account: Account or company that owns the resource
      - `accountId` string: Unique identifier of the account
      - `accountName` string: Name of the account
  - `account` Account: Account or company that owns the resource
    - `accountId` string: Unique identifier of the account
    - `accountName` string: Name of the account
  - `categories` object[]: Array of categories associated with the project
    - `categoryName` string: Name of the category
    - `categoryId` string: ID of the category (also known as categoryId)
    - `values` object[]: Array of assigned category values
      - `code` string: Code of the value
      - `value` string: Value of the value

## Other responses

- `401`: Unauthorized
- `404`: Not Found
- `500`: Internal Server Error

---

[API](https://skmtc.dev/mendix/apis/projects-api.md) - [All operations](https://skmtc.dev/mendix/apis/projects-api/llms.txt) - [OpenAPI document](https://skmtc.dev/mendix/apis/projects-api/revisions/3a958ca32c74?raw)