GET /rest/api/2/notificationscheme

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.

Servers

https://your-domain.atlassian.net

Query parameters

Name	Type	Required	Description
`id[]`	Array	No	The list of notification schemes IDs to be filtered by
`projectId[]`	Array	No	The list of projects IDs to be filtered by
`startAt`	String	No	The index of the first item to return in a page of results (page offset). Default value: "0"
`maxResults`	String	No	The maximum number of items to return per page. Default value: "50"
`expand`	String	No	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
`onlyDefault`	Boolean	No	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. Default value: false

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.