---
title: "Notification Search"
method: GET
path: "/notification"
tags: ["notification"]
---

# Notification Search

`GET /notification`

Search this users Notifications

## Query parameters

- `notificationId` integer
- `subject` string
- `embed` string
- `sortBy` 'subject' | 'type' | 'releaseDt' | 'isInterrupt'
- `sortDir` 'asc' | 'desc'

## Response `200`

successful operation

- Notification[]
  - `notificationId` integer — The Notifcation ID
  - `createDt` integer — Create Date as Unix Timestamp
  - `releaseDt` integer — Release Date as Unix Timestamp
  - `subject` string — The subject line
  - `type` string — The Notification type
  - `body` string — The HTML body of the notification
  - `isInterrupt` integer — Should the notification interrupt the CMS UI on navigate/login
  - `isSystem` integer — Flag for system notification
  - `userId` integer — The Owner User Id
  - `filename` string — Attachment filename
  - `originalFileName` string — Attachment originalFileName
  - `nonusers` string — Additional email addresses to which a saved report will be sent
  - `userGroups` UserGroup[] — User Group Notifications associated with this notification
    - `groupId` integer — The Group ID
    - `group` string — The group name
    - `isUserSpecific` integer — A flag indicating whether this is a user specific group or not
    - `isEveryone` integer — A flag indicating the special everyone group
    - `description` string — Description of this User Group
    - `libraryQuota` integer — This users library quota in bytes. 0 = unlimited
    - `isSystemNotification` integer — Does this Group receive system notifications.
    - `isDisplayNotification` integer — Does this Group receive display notifications.
    - `isDataSetNotification` integer — Does this Group receive DataSet notifications.
    - `isLayoutNotification` integer — Does this Group receive Layout notifications.
    - `isLibraryNotification` integer — Does this Group receive Library notifications.
    - `isReportNotification` integer — Does this Group receive Report notifications.
    - `isScheduleNotification` integer — Does this Group receive Schedule notifications.
    - `isCustomNotification` integer — Does this Group receive Custom notifications.
    - `isShownForAddUser` integer — Is this Group shown in the list of choices when onboarding a new user
    - `defaultHomepageId` string — Default Home page for new users
    - `features` string[] — Features this User Group has direct access to
  - `displayGroups` DisplayGroup[] — Display Groups associated with this notification
    - `displayGroupId` integer — The displayGroup Id
    - `displayGroup` string — The displayGroup Name
    - `description` string — The displayGroup Description
    - `isDisplaySpecific` integer — A flag indicating whether this displayGroup is a single display displayGroup
    - `isDynamic` integer — A flag indicating whether this displayGroup is dynamic
    - `dynamicCriteria` string — Criteria for this dynamic group. A comma separated set of regular expressions to apply
    - `dynamicCriteriaLogicalOperator` string — Which logical operator should be used when filtering by multiple dynamic criteria? OR|AND
    - `dynamicCriteriaTags` string — Criteria for this dynamic group. A comma separated set of tags to apply
    - `dynamicCriteriaExactTags` integer — Flag indicating whether to filter by exact Tag match
    - `dynamicCriteriaTagsLogicalOperator` string — Which logical operator should be used when filtering by multiple Tags? OR|AND
    - `userId` integer — The UserId who owns this display group
    - `tags` TagLink[] — Tags associated with this Display Group, array of TagLink objects
      - `tag` string — The Tag
      - `tagId` integer — The Tag ID
      - `value` string — The Tag Value
    - `bandwidthLimit` integer — The display bandwidth limit
    - `groupsWithPermissions` string — A comma separated list of groups/users with permissions to this DisplayGroup
    - `createdDt` string — The datetime this entity was created
    - `modifiedDt` string — The datetime this entity was last modified
    - `folderId` integer — The id of the Folder this Display Group belongs to
    - `permissionsFolderId` integer — The id of the Folder responsible for providing permissions for this Display Group
    - `ref1` string — Optional Reference 1
    - `ref2` string — Optional Reference 2
    - `ref3` string — Optional Reference 3
    - `ref4` string — Optional Reference 4
    - `ref5` string — Optional Reference 5
  - `canEdit` boolean — Flag indicating whether the current user can edit this notification
  - `canDelete` boolean — Flag indicating whether the current user can delete this notification

---

[API](https://skmtc.net/xibosignage/apis/xibo-api.md) · [All operations](https://skmtc.net/xibosignage/apis/xibo-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/xibosignage/xibo-api/revisions/fe497e811c7f/schema)