---
title: "Get a list of project roles for a specified account."
method: GET
path: "/accounts/{account-id}/roles"
tags: ["Accounts"]
---

# Get a list of project roles for a specified account.

`GET /accounts/{account-id}/roles`

## Request

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

Returns a list of project roles for a specified account or company. The output is restricted based on the authorization of the calling user. The calling user must be a member of the specified company.</br></br>Every request must be authenticated through a Personal Access Token containing the `mx:app:roles:read` scope.

## Path parameters

- `account-id` string, required

## Query parameters

- `changedSince` string, date-time
- `limit` integer
- `offset` integer

## Response `200`

OK

- object
  - `page` Page: Contains information about the current page, and the total number of elements to be retrieved.
    - `totalElements` integer: Total number of items to be expected
    - `offset` integer: Offset used by the current request
    - `elements` integer: Number of items in this current page
  - `items` ProjectRole[]: Array of roles.
    - `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

- `400`: Bad Request
- `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)