---
title: "Get project role details"
method: GET
path: "/rest/api/3/project/{projectIdOrKey}/roledetails"
tags: ["Project roles"]
---

# Get project role details

`GET /rest/api/3/project/{projectIdOrKey}/roledetails`

Returns all [project roles](https://support.atlassian.com/jira-cloud-administration/docs/manage-project-roles/) and the details for each role. Note that the list of project roles is common to all projects.

This operation can be accessed anonymously.

**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) or *Administer projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project.

## Path parameters

- `projectIdOrKey` string, required

## Query parameters

- `currentMember` boolean
- `excludeConnectAddons` boolean
- `excludeOtherServiceRoles` boolean

## Response `200`

Returned if the request is successful.

- ProjectRoleDetails[]
  - `admin` boolean — Whether this role is the admin role for the project.
  - `default` boolean — Whether this role is the default role for the project.
  - `description` string — The description of the project role.
  - `id` integer — The ID of the project role.
  - `name` string — The name of the project role.
  - `roleConfigurable` boolean — Whether the roles are configurable for this project.
  - `scope` Scope — The projects the item is associated with. Indicated for items associated with [next-gen projects](https://confluence.atlassian.com/x/loMyO).
    - `project` ProjectDetails — Details about a project.
      - `avatarUrls` AvatarUrlsBean
        - `16x16` string, uri — The URL of the item's 16x16 pixel avatar.
        - `24x24` string, uri — The URL of the item's 24x24 pixel avatar.
        - `32x32` string, uri — The URL of the item's 32x32 pixel avatar.
        - `48x48` string, uri — The URL of the item's 48x48 pixel avatar.
      - `id` string — The ID of the project.
      - `key` string — The key of the project.
      - `name` string — The name of the project.
      - `projectCategory` UpdatedProjectCategory — A project category.
        - `description` string — The name of the project category.
        - `id` string — The ID of the project category.
        - `name` string — The description of the project category.
        - `self` string — The URL of the project category.
      - `projectTypeKey` 'software' | 'service_desk' | 'business' — The [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes) of the project.
      - `self` string — The URL of the project details.
      - `simplified` boolean — Whether or not the project is simplified.
    - `type` 'PROJECT' | 'TEMPLATE' — The type of scope.
  - `self` string, uri — The URL the project role details.
  - `translatedName` string — The translated name of the project role.
  - `type` 'DEFAULT' | 'GUEST_ROLE' | 'AI_AGENT_ROLE' — The type of the project role. This is "DEFAULT" or "GUEST\_ROLE".

## Other responses

- `401` — Returned if the authentication credentials are incorrect or missing.
- `404` — Returned if the project is not found or if the user does not have the necessary permissions for the project.

---

[API](https://skmtc.net/atlassian/apis/the-jira-cloud-platform-rest-api-2.md) · [All operations](https://skmtc.net/atlassian/apis/the-jira-cloud-platform-rest-api-2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/atlassian/the-jira-cloud-platform-rest-api-2/versions/ec7f275dfee5/schema)