--- title: "Get notification schemes paginated" method: GET path: "/rest/api/3/notificationscheme" tags: ["Issue notification schemes"] --- # Get notification schemes paginated `GET /rest/api/3/notificationscheme` Returns a [paginated](#pagination) list of [notification schemes](https://confluence.atlassian.com/x/8YdKLg) ordered by the display name. *Note that you should allow for events without recipients to appear in responses.* **[Permissions](#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. ## Query parameters - `startAt` string - `maxResults` string - `id` string[] - `projectId` string[] - `onlyDefault` boolean - `expand` string ## Response `200` 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. - PageBeanNotificationScheme — A page of items. - `isLast` boolean — Whether this is the last page. - `maxResults` integer — The maximum number of items that could be returned. - `nextPage` string, uri — If there is another page of results, the URL of the next page. - `self` string, uri — The URL of the page. - `startAt` integer — The index of the first item returned. - `total` integer — The number of items returned. - `values` NotificationScheme[] — The list of items. - `description` string — The description of the notification scheme. - `expand` string — Expand options that include additional notification scheme details in the response. - `id` integer — The ID of the notification scheme. - `name` string — The name of the notification scheme. - `notificationSchemeEvents` NotificationSchemeEvent[] — The notification events and associated recipients. - `event` NotificationEvent — Details about a notification event. - `description` string — The description of the event. - `id` integer — The ID of the event. The event can be a [Jira system event](https://confluence.atlassian.com/x/8YdKLg#Creatinganotificationscheme-eventsEvents) or a [custom event](https://confluence.atlassian.com/x/AIlKLg). - `name` string — The name of the event. - `templateEvent` NotificationEvent — recursive - `notifications` EventNotification[] - `emailAddress` string — The email address. - `expand` string — Expand options that include additional event notification details in the response. - `field` FieldDetails — Details about a field. - `clauseNames` string[] — The names that can be used to reference the field in an advanced search. For more information, see [Advanced searching - fields reference](https://confluence.atlassian.com/x/gwORLQ). - `custom` boolean — Whether the field is a custom field. - `id` string — The ID of the field. - `key` string — The key of the field. - `name` string — The name of the field. - `navigable` boolean — Whether the field can be used as a column on the issue navigator. - `orderable` boolean — Whether the content of the field can be used to order lists. - `schema` JsonTypeBean — The schema of a field. - `configuration` object — If the field is a custom field, the configuration of the field. - `custom` string — If the field is a custom field, the URI of the field. - `customId` integer — If the field is a custom field, the custom ID of the field. - `items` string — When the data type is an array, the name of the field items within the array. - `system` string — If the field is a system field, the name of the field. - `type` string, required — The data type of the field. - `scope` Scope — The projects the item is associated with. Indicated for items associated with [next-gen projects](https://confluence.atlassian.com/x/loMyO). - `project` ProjectDetails — Details about a project. - … - `type` 'PROJECT' | 'TEMPLATE' — The type of scope. - `searchable` boolean — Whether the content of the field can be searched. - `group` GroupName — Details about a group. - `groupId` string, nullable — The ID of the group, which uniquely identifies the group across all Atlassian products. For example, *952d12c3-5b5b-4d04-bb32-44d383afc4b2*. - `name` string — The name of group. - `self` string, uri — The URL for these group details. - `id` integer — The ID of the notification. - `notificationType` 'CurrentAssignee' | 'Reporter' | 'CurrentUser' | 'ProjectLead' | 'ComponentLead' | 'User' | 'Group' | 'ProjectRole' | 'EmailAddress' | 'AllWatchers' | 'UserCustomField' | 'GroupCustomField' — Identifies the recipients of the notification. - `parameter` string — As a group's name can change, use of `recipient` is recommended. The identifier associated with the `notificationType` value that defines the receiver of the notification, where the receiver isn't implied by `notificationType` value. So, when `notificationType` is: * `User` The `parameter` is the user account ID. * `Group` The `parameter` is the group name. * `ProjectRole` The `parameter` is the project role ID. * `UserCustomField` The `parameter` is the ID of the custom field. * `GroupCustomField` The `parameter` is the ID of the custom field. - `projectRole` ProjectRole — Details about the roles in a project. - `actors` RoleActor[] — The list of users who act in this role. - `actorGroup` ProjectRoleGroup — Details of the group associated with the role. - … - `actorUser` ProjectRoleUser — Details of the user associated with the role. - … - `avatarUrl` string, uri — The avatar of the role actor. - `displayName` string — The display name of the role actor. For users, depending on the user’s privacy setting, this may return an alternative value for the user's name. - `id` integer — The ID of the role actor. - `name` string — This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. - `type` 'atlassian-group-role-actor' | 'atlassian-user-role-actor' — The type of role actor. - `admin` boolean — Whether this role is the admin role for the project. - `currentUserRole` boolean — Whether the calling user is part of this role. - `default` boolean — Whether this role is the default role for the project - `description` string — The description of the project role. - `id` integer — The ID of the project role. - `name` string — The name of the project role. - `roleConfigurable` boolean — Whether the roles are configurable for this project. - `scope` Scope — The projects the item is associated with. Indicated for items associated with [next-gen projects](https://confluence.atlassian.com/x/loMyO). - `project` ProjectDetails — Details about a project. - … - `type` 'PROJECT' | 'TEMPLATE' — The type of scope. - `self` string, uri — The URL the project role details. - `translatedName` string — The translated name of the project role. - `recipient` string — The identifier associated with the `notificationType` value that defines the receiver of the notification, where the receiver isn't implied by the `notificationType` value. So, when `notificationType` is: * `User`, `recipient` is the user account ID. * `Group`, `recipient` is the group ID. * `ProjectRole`, `recipient` is the project role ID. * `UserCustomField`, `recipient` is the ID of the custom field. * `GroupCustomField`, `recipient` is the ID of the custom field. - `user` UserDetails — User details permitted by the user's Atlassian Account privacy settings. However, be aware of these exceptions: * User record deleted from Atlassian: This occurs as the result of a right to be forgotten request. In this case, `displayName` provides an indication and other parameters have default values or are blank (for example, email is blank). * User record corrupted: This occurs as a results of events such as a server import and can only happen to deleted users. In this case, `accountId` returns *unknown* and all other parameters have fallback values. * User record unavailable: This usually occurs due to an internal service outage. In this case, all parameters have fallback values. - `accountId` string — The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. - `accountType` string — The type of account represented by this user. This will be one of 'atlassian' (normal users), 'app' (application user) or 'customer' (Jira Service Desk customer user) - `active` boolean — Whether the user is active. - `avatarUrls` AvatarUrlsBean - `16x16` string, uri — The URL of the item's 16x16 pixel avatar. - `24x24` string, uri — The URL of the item's 24x24 pixel avatar. - `32x32` string, uri — The URL of the item's 32x32 pixel avatar. - `48x48` string, uri — The URL of the item's 48x48 pixel avatar. - `displayName` string — The display name of the user. Depending on the user’s privacy settings, this may return an alternative value. - `emailAddress` string — The email address of the user. Depending on the user’s privacy settings, this may be returned as null. - `key` string — This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. - `name` string — This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. - `self` string — The URL of the user. - `timeZone` string — The time zone specified in the user's profile. Depending on the user’s privacy settings, this may be returned as null. - `projects` integer[] — The list of project IDs associated with the notification scheme. - `scope` Scope — The projects the item is associated with. Indicated for items associated with [next-gen projects](https://confluence.atlassian.com/x/loMyO). - `project` ProjectDetails — Details about a project. - `avatarUrls` AvatarUrlsBean - `16x16` string, uri — The URL of the item's 16x16 pixel avatar. - `24x24` string, uri — The URL of the item's 24x24 pixel avatar. - `32x32` string, uri — The URL of the item's 32x32 pixel avatar. - `48x48` string, uri — The URL of the item's 48x48 pixel avatar. - `id` string — The ID of the project. - `key` string — The key of the project. - `name` string — The name of the project. - `projectCategory` UpdatedProjectCategory — A project category. - `description` string — The name of the project category. - `id` string — The ID of the project category. - `name` string — The description of the project category. - `self` string — The URL of the project category. - `projectTypeKey` 'software' | 'service_desk' | 'business' — The [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes) of the project. - `self` string — The URL of the project details. - `simplified` boolean — Whether or not the project is simplified. - `type` 'PROJECT' | 'TEMPLATE' — The type of scope. - `self` string ## Other responses - `400` — Returned if the request isn't valid. - `401` — Returned if the authentication credentials are incorrect or missing. --- [API](https://skmtc.net/atlassian/apis/the-jira-cloud-platform-rest-api-2.md) · [All operations](https://skmtc.net/atlassian/apis/the-jira-cloud-platform-rest-api-2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/atlassian/the-jira-cloud-platform-rest-api-2/versions/ec7f275dfee5/schema)