Issue notification schemes

Get notification scheme

Changed on

Returns a notification scheme, including the list of events and the recipients who will receive notifications for those events.

Permissions required: Permission to access Jira, however, the user must have permission to administer at least one project associated with the notification scheme.

get/rest/api/2/notificationscheme/{id}

Request

  • Base URL: https://your-domain.atlassian.net
  • URL: https://your-domain.atlassian.net/rest/api/2/notificationscheme/{id}
  • Auth: one of:
    • HTTP basic
    • OAuth 2 (authorization code, authorization URL https://auth.atlassian.com/authorize, token URL https://auth.atlassian.com/oauth/token, scopes: manage:jira-configuration)

Path parameters

idinteger required

The ID of the notification scheme. Use Get notification schemes paginated to get a list of notification scheme IDs.

Query parameters

expandstring

Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include:

  • all Returns all expandable information
  • field Returns information about any custom fields assigned to receive an event
  • group Returns information about any groups assigned to receive an event
  • notificationSchemeEvents Returns a list of event associations. This list is returned for all expandable information
  • projectRole Returns information about any project roles assigned to receive an event
  • user Returns information about any users assigned to receive an event

Response

Returned if the request is successful.

descriptionstring

The description of the notification scheme.

expandstring

Expand options that include additional notification scheme details in the response.

idinteger

The ID of the notification scheme.

namestring

The name of the notification scheme.

projectsinteger[]

The list of project IDs associated with the notification scheme.

selfstring

Changes

  • 38a98954789eRevision changes
    • warning

      added the new product_discovery enum value to the /////////////////// response property for the response status

    • warning

      added the new product_discovery enum value to the /////////////////// response property for the response status

    • warning

      added the new product_discovery enum value to the ////////// response property for the response status