Sign in
Issue notification schemes

Get notification schemes paginated

Returns a paginated list of notification schemes ordered by the display name.

Note that you should allow for events without recipients to appear in responses.

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

get/rest/api/2/notificationscheme

Query parameters

startAtstring

The index of the first item to return in a page of results (page offset).

maxResultsstring

The maximum number of items to return per page.

idstring[]

The list of notification schemes IDs to be filtered by

projectIdstring[]

The list of projects IDs to be filtered by

onlyDefaultboolean

When set to true, returns only the default notification scheme. If you provide project IDs not associated with the default, returns an empty page. The default value is false.

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. Only returns notification schemes that the user has permission to access. An empty list is returned if the user lacks permission to access all notification schemes.

isLastboolean

Whether this is the last page.

maxResultsinteger

The maximum number of items that could be returned.

nextPagestring uri

If there is another page of results, the URL of the next page.

selfstring uri

The URL of the page.

startAtinteger

The index of the first item returned.

totalinteger

The number of items returned.

Changes

Changed in 1 of the 15 revisions of this API.3

  • 38a98954789e3See the full diff
    • ●

      added the new product_discovery enum value to the values/items/notificationSchemeEvents/items/notifications/items/field/allOf[FieldDetails]/scope/allOf[Scope]/project/allOf[ProjectDetails]/projectTypeKey response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new product_discovery enum value to the values/items/notificationSchemeEvents/items/notifications/items/projectRole/allOf[ProjectRole]/scope/allOf[Scope]/project/allOf[ProjectDetails]/projectTypeKey response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new product_discovery enum value to the values/items/scope/allOf[Scope]/project/allOf[ProjectDetails]/projectTypeKey response property for the response status 200

      response-property-enum-value-added