Jira

Jira Project roles API

This resource represents the roles that users can play in projects. Use this resource to get, create, update, and delete project roles.

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 in a project · Get project roles for project #
Ask an LLM
“What project roles exist in a given project?”
“Can I get the names and links of every role in my project?”
Tell an agent
List the project roles for project {projectIdOrKey}.
Show role names and URLs in project {projectIdOrKey}.
GET /rest/api/3/project/{projectIdOrKey}/role/{id} See who holds a role in a project · Get project role for project #
Ask an LLM
“Who are the users and groups in the Developers role of my project?”
“Can I leave inactive users out when listing a project role's members?”
Tell an agent
Show the actors in role {id} for project {projectIdOrKey}.
List members of role {id} in project {projectIdOrKey}, excluding inactive users: {excludeInactiveUsers}.
GET /rest/api/3/project/{projectIdOrKey}/roledetails Get details of every role for a project · Get project role details #
Ask an LLM
“Which project roles am I a member of in this project?”
“Can I get role details for a project without roles from other services or Connect add-ons?”
Tell an agent
Get the role details for project {projectIdOrKey}.
Show only the roles I belong to in project {projectIdOrKey} where current member is {currentMember}.
GET /rest/api/3/role List all project roles site-wide · Get all project roles #
Ask an LLM
“What project roles are defined across the whole Jira site?”
“Which default actors does each project role have?”
Tell an agent
List all project roles on the site with their default actors.
Show every project role definition globally.
POST /rest/api/3/role Create a new project role · Create project role #
Ask an LLM
“How do I define a new project role like QA Lead?”
“Does a newly created project role start with any default actors?”
Tell an agent
Create a project role named {name}.
Create project role {name} described as {description}.
DELETE /rest/api/3/role/{id} Delete a project role · Delete project role #
Ask an LLM
“How do I delete a project role that's still in use?”
“Can I swap in a replacement role when deleting one?”
Tell an agent destructive · confirm first
Delete project role {id}.
Delete role {id} and replace it with role {swap} wherever it's used.
GET /rest/api/3/role/{id} Get a project role and its default actors · Get project role by ID #
Ask an LLM
“Which default actors are attached to a specific project role?”
“How do I look up a global project role 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 · Partial update project role #
Ask an LLM
“How do I rename a project role without touching its description?”
“Can I update just the description of a project role?”
Tell an agent
Rename project role {id} to {name}, leaving its description alone.
Change only the description of role {id} to {description}.
PUT /rest/api/3/role/{id} Replace a project role's name and description · Fully update project role #
Ask an LLM
“Can I change both the name and description of a role in one request?”
“Must I send both fields when fully updating a project 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

📖
Documentation
https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/
📖
Authentication
https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#authentication
📖
Documentation
https://developer.atlassian.com/cloud/jira/software/rest/intro/
📖
Documentation
https://developer.atlassian.com/cloud/jira/service-desk/rest/intro/
📖
APIReference
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues/

Specifications

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

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/jira:jira-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

jira-project-roles-api-openapi.yml Raw ↑ 
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: https://developer.atlassian.com/platform/marketplace/atlassian-developer-terms/
  title: Jira Cloud platform REST Project roles API
  version: 1001.0.0-SNAPSHOT-82b018affa468e58f284fbe4df33536469d757df
servers:
- url: https://your-domain.atlassian.net
tags:


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