Jira

Jira Issue notification schemes API

This resource represents notification schemes, lists of events and the recipients who will receive notifications for those events. Use it to get details of a notification scheme and a list of notification schemes. ### About notification schemes ### A notification scheme is a list of events and recipients who will receive notifications for those events. The list is contained within the `notificationSchemeEvents` object and contains pairs of `events` and `notifications`: * `event` Identifies the type of event. The events can be [Jira system events](https://support.atlassian.com/jira-cloud-administration/docs/configure-notification-schemes/) (see the *Events* section) or [custom events](https://support.atlassian.com/jira-cloud-administration/docs/add-a-custom-event/). * `notifications` Identifies the [recipients](https://confluence.atlassian.com/x/8YdKLg#Creatinganotificationscheme-recipientsRecipients) of notifications for each event. Recipients can be any of the following types: * `CurrentAssignee` * `Reporter` * `CurrentUser` * `ProjectLead` * `ComponentLead` * `User` (the `parameter` is the user key) * `Group` (the `parameter` is the group name) * `ProjectRole` (the `parameter` is the project role ID) * `EmailAddress` *(deprecated)* * `AllWatchers` * `UserCustomField` (the `parameter` is the ID of the custom field) * `GroupCustomField`(the `parameter` is the ID of the custom field)

GitHub OpenAPI

Operations 8

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/notificationscheme List notification schemes · Get notification schemes paginated #
Ask an LLM
“What notification schemes are set up in Jira?”
“Can I find the notification scheme a specific project uses?”
Tell an agent
List all notification schemes.
Show the notification scheme used by project {projectId}.
POST /rest/api/3/notificationscheme Create a notification scheme · Create notification scheme #
Ask an LLM
“How do I create a new notification scheme with its events and recipients?”
“How many notifications can I include when creating a scheme?”
Tell an agent
Create a notification scheme named {name}.
Create notification scheme {name} described as {description} with events {notificationSchemeEvents}.
GET /rest/api/3/notificationscheme/project See which projects use which notification scheme · Get projects using notification schemes paginated #
Ask an LLM
“Which projects are assigned to a particular notification scheme?”
“Can I map every project to its notification scheme?”
Tell an agent
List projects using notification scheme {notificationSchemeId}.
Show the project-to-notification-scheme mappings for all projects.
GET /rest/api/3/notificationscheme/{id} Get a notification scheme's events · Get notification scheme #
Ask an LLM
“Who gets notified for each event in a notification scheme?”
“Can I view one notification scheme with its recipients?”
Tell an agent
Get notification scheme {id}.
Show the events and recipients in notification scheme {id}.
PUT /rest/api/3/notificationscheme/{id} Rename or describe a notification scheme · Update notification scheme #
Ask an LLM
“Can I rename a notification scheme or change its description?”
“Does updating a notification scheme change its events?”
Tell an agent
Rename notification scheme {id} to {name}.
Set the description of notification scheme {id} to {description}.
PUT /rest/api/3/notificationscheme/{id}/notification Add notifications to a scheme · Add notifications to notification scheme #
Ask an LLM
“Can I add new event recipients to an existing notification scheme?”
“Is the EmailAddress notification type still supported when adding notifications?”
Tell an agent
Add notifications {notificationSchemeEvents} to scheme {id}.
Notify extra recipients on scheme {id} using events {notificationSchemeEvents}.
DELETE /rest/api/3/notificationscheme/{notificationSchemeId} Delete a notification scheme · Delete notification scheme #
Ask an LLM
“Can I delete a notification scheme I no longer need?”
“Who has permission to remove a notification scheme?”
Tell an agent destructive · confirm first
Delete notification scheme {notificationSchemeId}.
Remove the unused notification scheme {notificationSchemeId}.
DELETE /rest/api/3/notificationscheme/{notificationSchemeId}/notification/{notificationId} Remove one notification from a scheme · Remove notification from notification scheme #
Ask an LLM
“Can I stop one recipient from being notified without deleting the whole scheme?”
“What does removing a single notification from a scheme do?”
Tell an agent destructive · confirm first
Remove notification {notificationId} from scheme {notificationSchemeId}.
Delete recipient entry {notificationId} in notification scheme {notificationSchemeId}.

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-issue-notification-schemes-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-issue-notification-schemes-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-issue-notification-schemes-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 Issue notification schemes API
  version: 1001.0.0-SNAPSHOT-82b018affa468e58f284fbe4df33536469d757df
servers:
- url: https://your-domain.atlassian.net
tags:


# --- truncated at 32 KB (82 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/jira/refs/heads/main/openapi/jira-issue-notification-schemes-api-openapi.yml