---
title: "Get all details of a specific project role"
method: GET
path: "/roles/{role-id}"
tags: ["Roles"]
---

# Get all details of a specific project role

`GET /roles/{role-id}`

## Request

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

Get all details of a specific project role.</br></br>Every request must be authenticated by a Personal Access Token containing the scope `mx:app:roles:read`.

## Path parameters

- `role-id` string, uuid, required

## Response `200`

OK

- ProjectRole
  - `roleId` string, uuid: Unique identifier for roles on the Mendix platform.
  - `roleName` string: Name of the role.
  - `roleDescription` string: Description of the role.
  - `account` Account: Account or company that owns the resource
    - `accountId` string: Unique identifier of the account
    - `accountName` string: Name of the account
  - `isAdministrator` boolean: Indicates whether the role is a project administrator.
  - `hasRepositoryAccess` boolean: Indicates whether the role is allowed to make changes to the app's model.
  - `hasCloudAccess` boolean: Indicates whether the role has access to the cloud environments.
  - `hasStoryAccess` boolean: Indicates whether the role has access to Stories and Feedback of the app.
  - `hasInvitationRights` boolean: Indicates whether the role is allowed to invite other users to the project team.
  - `environmentPermissions` object[]: Array of environment permissions.
    - `environmentType` 'non_production' | 'production': The type of environment.
    - `accessType` 'no_access' | 'access' | 'custom': The type of access.
    - `hasManageRights` boolean: Indicates whether the role has environment management rights.
    - `hasTransportRights` boolean: Indicates whether the role has environment transportation rights.
    - `hasBackupAccess` boolean: Indicates whether the role is allowed to access the environment's backups.
    - `hasMonitoringAccess` boolean: Indicates whether the role has access to the environment's monitoring.
    - `hasApiRights` boolean: Indicates whether the role has environment API rights.

## 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)