How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Atlassian Issue Notification Schemes API

The Issue Notification Schemes API from Atlassian — 6 operation(s) for issue notification schemes.

Atlassian Issue Notification Schemes API is one of 183 APIs that Atlassian publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 17 JSON Schema definitions.

Tagged areas include Issue Notification Schemes. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 17 JSON Schemas.

This API exposes 8 operations across 6 paths, and defines 27 schemas. It is described by OpenAPI 3.2.0, at version 1001.0.0-SNAPSHOT-67b5c6e5f3598d7ec1649016d026468ab2838a77.

Requests are made against a single base URL, https://your-domain.atlassian.net.

8 operations 6 paths 27 schemas 2 DELETE3 GET1 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1001.0.0-SNAPSHOT-67b5c6e5f3598d7ec1649016d026468ab2838a77
Server
https://your-domain.atlassian.net
Authentication
OAuth 2.0, HTTP Basic
License
Terms of Service
Resource Areas
1

Authentication & Security 2

Atlassian Issue Notification Schemes API declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (OAuth2) using the authorizationCode flow, exposing 183 scopes. It accepts HTTP basic authentication (basicAuth).

  • OAuth2 — OAuth2 scopes for Jira
  • basicAuth — You can access this resource via basic auth.

Paths & Operations 8

Across 6 paths, the API surfaces 8 operations — 2 DELETE, 3 GET, 1 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Issue Notification Schemes 8
GET
/rest/api/3/notificationscheme
Atlassian Get Notification Schemes Paginated
atlassianGetnotificationschemes 6 params → 200400401
POST
/rest/api/3/notificationscheme
Atlassian Create Notification Scheme
atlassianCreatenotificationscheme body → 201400401403
GET
/rest/api/3/notificationscheme/project
Atlassian Get Projects Using Notification Schemes Paginated
atlassianGetnotificationschemetoprojectmappings 4 params → 200400401
GET
/rest/api/3/notificationscheme/{id}
Atlassian Get Notification Scheme
atlassianGetnotificationscheme 2 params → 200400401404
PUT
/rest/api/3/notificationscheme/{id}
Atlassian Update Notification Scheme
atlassianUpdatenotificationscheme 1 param body → 204400401403404
PUT
/rest/api/3/notificationscheme/{id}/notification
Atlassian Add Notifications To Notification Scheme
atlassianAddnotifications 1 param body → 204400401403404
DELETE
/rest/api/3/notificationscheme/{notificationSchemeId}
Atlassian Delete Notification Scheme
atlassianDeletenotificationscheme 1 param → 204400401403404
DELETE
/rest/api/3/notificationscheme/{notificationSchemeId}/notification/{notificationId}
Atlassian Remove Notification From Notification Scheme
atlassianRemovenotificationfromnotificationscheme 2 params → 204400401403404

Schemas 27

The contract defines 27 schemas that model the data the API accepts and returns. The most detailed are ProjectRole (11 properties), EventNotification (10 properties), FieldDetails (10 properties), UserDetails (10 properties). Each schema is shown below with its type and property counts.

Scope
object
The projects the item is associated with. Indicated for items associated with [next-gen projects](https://confluence.atlassian.com/x/loMyO).
2 properties
ProjectRoleUser
object
Details of the user associated with the role.
1 property
NotificationSchemeAndProjectMappingJsonBean
object
2 properties
NotificationSchemeEventTypeId
object
The ID of an event that is being mapped to notifications.
1 property 1 required
UpdatedProjectCategory
object
A project category.
4 properties
ProjectRoleGroup
object
Details of the group associated with the role.
3 properties
PageBeanNotificationSchemeAndProjectMappingJsonBean
object
A page of items.
7 properties
AddNotificationsDetails
object
Details of notifications which should be added to the notification scheme.
1 property 1 required
CreateNotificationSchemeDetails
object
Details of an notification scheme.
3 properties 1 required
FieldDetails
object
Details about a field.
10 properties
EventNotification
object
Details about a notification associated with an event.
10 properties
UpdateNotificationSchemeDetails
object
Details of a notification scheme.
2 properties
PageBeanNotificationScheme
object
A page of items.
7 properties
ProjectRole
object
Details about the roles in a project.
11 properties
NotificationSchemeEvent
object
Details about a notification scheme event.
2 properties
ErrorCollection
object
Error messages from an operation.
3 properties
GroupName
object
Details about a group.
3 properties
NotificationSchemeId
object
The ID of a notification scheme.
1 property 1 required
NotificationSchemeNotificationDetails
object
Details of a notification within a notification scheme.
2 properties 1 required
NotificationEvent
object
Details about a notification event.
4 properties
NotificationSchemeEventDetails
object
Details of a notification scheme event.
2 properties 2 required
NotificationScheme
object
Details about a notification scheme.
8 properties
ProjectDetails
object
Details about a project.
8 properties
JsonTypeBean
object
The schema of a field.
6 properties 1 required
RoleActor
object
Details about a user assigned to a project role.
7 properties
AvatarUrlsBean
object
4 properties
UserDetails
object
User details permitted by the user's Atlassian Account privacy settings. However, be aware of these exceptions: User record deleted from Atlassian: This occurs…
10 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

atlassian-issue-notification-schemes-api-openapi.yml Raw ↑

Other APIs Atlassian publishes across the network.

Atlassian Jira Software Backlog API
Atlassian Jira Software Board API
Atlassian Jira Software Epic API
Atlassian Jira Software Sprint API
Atlassian Jira Software Development Information API
Atlassian Jira Software Feature Flags API
Atlassian Jira Software Deployments API
Atlassian Jira Software Builds API
Atlassian Jira Software Remote Links API
Atlassian Jira Software Security Information API
Atlassian Jira Service Management Customer API
Atlassian Jira Service Management Info API
Where this information came from

This is an independent, third-party profile of Atlassian Issue Notification Schemes API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.