Atlassian

Atlassian Project Roles API

The Project Roles API from Atlassian — 5 operation(s) for project roles.

Documentation GitHub OpenAPI

Operations 9

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /rest/api/3/project/{projectIdOrKey}/role List the roles for a project · Atlassian Get Project Roles For Project #

Ask an LLM

“Which project roles exist in a given Jira project?”

“Can I get just role names and links for a single project?”

Tell an agent

List the project roles for project {projectIdOrKey}.

Show role names available in project {projectIdOrKey}.

GET /rest/api/3/project/{projectIdOrKey}/role/{id} See who holds a role in a project · Atlassian Get Project Role For Project #

Ask an LLM

“Who are the actors in a specific role on a project?”

“Can I leave inactive users out when listing a project role's members?”

Tell an agent

Show the actors in role {id} on project {projectIdOrKey}.

List role {id} members in project {projectIdOrKey}, excluding inactive users {excludeInactiveUsers}.

GET /rest/api/3/project/{projectIdOrKey}/roledetails Get project role details for a project · Atlassian Get Project Role Details #

Ask an LLM

“Which project roles am I a member of in a given project?”

“Can I hide Connect app roles when listing a project's role details?”

Tell an agent

Get role details for project {projectIdOrKey}.

Show only roles I belong to in project {projectIdOrKey} ({currentMember}).

GET /rest/api/3/role List all project roles site-wide · Atlassian Get All Project Roles #

Ask an LLM

“What project roles are defined across the whole Jira site?”

“Can I see every role's default actors in one call?”

Tell an agent

List all project roles in Jira with their default actors.

Show me every project role defined on the site.

POST /rest/api/3/role Create a new project role · Atlassian Create Project Role #

Ask an LLM

“How do I add a new project role to Jira?”

“Does a new project role start with any default actors?”

Tell an agent

Create a project role called {name}.

Create project role {name} described as {description}.

DELETE /rest/api/3/role/{id} Delete a project role · Atlassian Delete Project Role #

Ask an LLM

“How do I delete a project role that's still in use?”

“Is a replacement role required when removing a role?”

Tell an agent destructive · confirm first

Delete project role {id}.

Delete role {id} and swap its usages to role {swap}.

GET /rest/api/3/role/{id} Get a project role and its default actors · Atlassian Get Project Role By Id #

Ask an LLM

“Who are the default actors on a given project role?”

“Can I look up a project role globally by its ID?”

Tell an agent

Get project role {id} with its default actors.

Show the site-wide definition of role {id}.

POST /rest/api/3/role/{id} Change only a project role's name or description · Atlassian Partial Update Project Role #

Ask an LLM

“Can I rename a project role without touching its description?”

“What happens if I send a name and a description in a partial role update?”

Tell an agent

Rename only project role {id} to {name}.

Update just the description of role {id} to {description}.

PUT /rest/api/3/role/{id} Replace a project role's name and description · Atlassian Fully Update Project Role #

Ask an LLM

“How do I change both the name and description of a project role together?”

“Must I send both fields when fully updating a role?”

Tell an agent

Set role {id}'s name to {name} and description to {description}.

Fully replace project role {id} with name {name} and description {description}.

Documentation

https://developer.atlassian.com/cloud/bitbucket/rest/api-group-addon/

https://developer.atlassian.com/cloud/bitbucket/rest/api-group-webhooks/

https://developer.atlassian.com/cloud/bitbucket/rest/api-group-pullrequests/

https://developer.atlassian.com/cloud/bitbucket/rest/api-group-repositories/

https://developer.atlassian.com/cloud/bitbucket/rest/api-group-snippets/

https://developer.atlassian.com/cloud/bitbucket/rest/api-group-workspaces/

https://developer.atlassian.com/cloud/bitbucket/rest/api-group-users/

https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-analytics/

https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-audit/

https://developer.atlassian.com/cloud/confluence/connect-modules/

https://developer.atlassian.com/cloud/confluence/rest/v2/intro/

https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-body/

https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-states/

https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-group/

https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-inline-tasks

https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-labels/

https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-long-running-task/

https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-relation/

https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-search/

https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-settings/

https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-space/

https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-template/

https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-user/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-announcement-banner/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-values--apps-/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-app-openapi

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-application-roles/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-attachments/

https://developer.atlassian.com/server/framework/atlassian-sdk/audit/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-avatars/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-classification-levels/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-comments/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-components/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-jira-settings/

https://developer.atlassian.com/cloud/jira/platform/getting-started-with-connect/

https://developer.atlassian.com/cloud/jira/platform/connect-api-migration/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-service-registry/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-options/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-dashboards/

https://developer.atlassian.com/cloud/jira/platform/data-security-policy-developer-guide/

https://developer.atlassian.com/platform/forge/events-reference/jira/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-jira-expressions/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-fields/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-field-configurations/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-filters/

https://developer.atlassian.com/cloud/jira/platform/forge/

https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-groups/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-group-and-user-picker/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-groups/

https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-issues/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-links/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-security-schemes/

https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-issue-types/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-type-schemes/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-type-screen-schemes/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-search/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-labels/

https://developer.atlassian.com/platform/marketplace/license-api-for-cloud-apps/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-license-metrics/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-permissions/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-myself/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-notification-schemes/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-permission-schemes/

https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-issue-priorities/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-projects/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-categories/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-key-and-name-validation/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-resolutions/

https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-project-roles/

https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-screens/

https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-screen-schemes/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-security-level/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-server-info/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-statuses/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-status-categories/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-tasks/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-ui-modifications--apps-/

https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-avatars/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-users/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-versions/

https://developer.atlassian.com/server/jira/platform/webhooks/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflows/

https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-workflow-schemes/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-worklogs/

https://developer.atlassian.com/cloud/admin/organization/rest/

https://developer.atlassian.com/cloud/admin/user-management/rest/

https://developer.atlassian.com/cloud/admin/user-provisioning/rest/

Specifications

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/openapi/atlassian-project-roles-api-openapi.yml

Schemas & Data

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-schema/atlassian-bitbucket-hook-events-paginated_hook_events-schema.json

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-schema/atlassian-bitbucket-pull-requests-a_pullrequest_comment_task-schema.json

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-schema/atlassian-bitbucket-repositories-account-schema.json

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-schema/atlassian-bitbucket-snippets-account-schema.json

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-schema/atlassian-bitbucket-teams-account-schema.json

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-schema/atlassian-bitbucket-user-account-schema.json

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-schema/atlassian-bitbucket-workspaces-account-schema.json

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-schema/atlassian-confluence-content-body-async-content-body-schema.json

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-schema/atlassian-confluence-content-states-async-id-schema.json

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-schema/atlassian-confluence-group-group-array-with-links-schema.json

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-schema/atlassian-confluence-inline-tasks-task-page-response-schema.json

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-schema/atlassian-confluence-longtask-long-task-status-with-links-schema.json

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-schema/atlassian-confluence-search-search-page-response-search-result-schema.json

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-schema/atlassian-confluence-space-content-state-settings-schema.json

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-schema/atlassian-confluence-template-blueprint-template-array-schema.json

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-schema/atlassian-confluence-user-account-id-email-record-schema.json

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-schema/atlassian-admin-domain-page-schema.json

Other Resources

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-bitbucket-hook-events-context.jsonld

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-bitbucket-pull-requests-context.jsonld

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-bitbucket-repositories-context.jsonld

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-bitbucket-snippets-context.jsonld

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-bitbucket-teams-context.jsonld

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-bitbucket-user-context.jsonld

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-bitbucket-workspaces-context.jsonld

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-confluence-audit-context.jsonld

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-confluence-content-context.jsonld

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-confluence-content-body-context.jsonld

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-confluence-content-states-context.jsonld

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-confluence-group-context.jsonld

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-confluence-inline-tasks-context.jsonld

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-confluence-longtask-context.jsonld

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-confluence-relation-context.jsonld

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-confluence-search-context.jsonld

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-confluence-settings-context.jsonld

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-confluence-space-context.jsonld

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-confluence-template-context.jsonld

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-confluence-user-context.jsonld

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-admin-context.jsonld

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/atlassian:atlassian-project-roles-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  contact:
    email: ecosystem@atlassian.com
  description: Jira Cloud platform REST API documentation
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  termsOfService: http://atlassian.com/terms/
  title: Atlassian The Jira Cloud platform REST Project Roles API
  version: 1001.0.0-SNAPSHOT-67b5c6e5f3598d7ec1649016d026468ab2838a77
servers:
- url: https://your-domain.atlassian.net
tags:


# --- truncated at 32 KB (59 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/openapi/atlassian-project-roles-api-openapi.yml