Search SystemNotifications

GET

api

sys

systemnotifications

curl --request GET \
  --url https://spaces.nexudus.com/api/sys/systemnotifications \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/sys/systemnotifications"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/sys/systemnotifications', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

A SystemNotification represents a platform-level notification displayed to administrators, such as billing alerts, integration issues, or system announcements. Notifications have a severity level and message type.

Authentication

This endpoint requires OAuth2 authentication. Include a valid bearer token in the Authorization header. The authenticated user must be a full unrestricted administrator or have the SystemNotification-List role.

Enums

eSystemNotificationSeverity — Severity values

Value	Name
1	Low
2	Medium
3	High

eSystemNotificationMessageType — MessageType values

Value	Name
1	Issue
2	Announcement

Query Parameters

Pagination & Sorting

integer

default:"1"

The page number to retrieve.

integer

default:"25"

The number of records per page.

string

The property name to sort results by (e.g. Name, CreatedOn).

integer

Sort direction. 0 for ascending, 1 for descending.

Filters

string

Filter by the title value for this system notification.

integer

Filter by the severity value for this system notification.

string

Filter by date/time value for start time.

string

Filter by date/time value for publish on.

string

Filter by date/time value for un publish on.

string

Filter by the short description value for this system notification.

string

Filter by free-text description of this system notification.

string

Filter by the resolution description value for this system notification.

boolean

Filter by whether resolved is enabled.

string

Filter by date/time value for resolved on.

boolean

Filter by whether display to admins is enabled.

string

Filter by the display to setting integrations value for this system notification.

string

Filter by the display to setting general value for this system notification.

string

Filter by the display to portal version value for this system notification.

string

Filter by the approved by value for this system notification.

string

Filter by date/time value for approved on.

integer

Filter by the message type value for this system notification.

boolean

Filter by whether has button is enabled.

string

Filter by the button label value for this system notification.

string

Filter by the button url value for this system notification.

Range Filters

string

Filter by date/time value for start time greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by date/time value for start time less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by date/time value for publish on greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by date/time value for publish on less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by date/time value for un publish on greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by date/time value for un publish on less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by date/time value for resolved on greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by date/time value for resolved on less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by date/time value for approved on greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by date/time value for approved on less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter records created on or after this date. Format: YYYY-MM-DDTHH:mm.

string

Filter records created on or before this date. Format: YYYY-MM-DDTHH:mm.

string

Filter records updated on or after this date. Format: YYYY-MM-DDTHH:mm.

string

Filter records updated on or before this date. Format: YYYY-MM-DDTHH:mm.

Code Examples

Simple listing

curl -X GET \
  "https://spaces.nexudus.com/api/sys/systemnotifications?page=1&size=15&orderBy=Title&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/sys/systemnotifications?' + new URLSearchParams({
    page: 1,
    size: 15,
    orderBy: 'Title',
    dir: 1 // Ascending
  }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/sys/systemnotifications',
    params={
        'page': 1,
        'size': 15,
        'orderBy': 'Title',
        'dir': 0 // Ascending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Filtering by Title

curl -X GET \
  "https://spaces.nexudus.com/api/sys/systemnotifications?SystemNotification_Title=example-value&orderBy=Title&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/sys/systemnotifications?' + new URLSearchParams({
    SystemNotification_Title: 'example-value',
    orderBy: 'Title',
    dir: 1
  }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/sys/systemnotifications',
    params={
        'SystemNotification_Title': 'example-value',
        'orderBy': 'Title',
        'dir': 0 // Ascending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Range filters

curl -X GET \
  "https://spaces.nexudus.com/api/sys/systemnotifications?from_SystemNotification_UpdatedOn=2025-01-01T00:00&to_SystemNotification_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/sys/systemnotifications?' + new URLSearchParams({
    from_SystemNotification_UpdatedOn: '2025-01-01T00:00',
    to_SystemNotification_UpdatedOn: '2025-12-31T23:59',
    orderBy: 'UpdatedOn',
    dir: 1 // Descending
   }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/sys/systemnotifications',
    params={
        'from_SystemNotification_UpdatedOn': '2025-01-01T00:00',
        'to_SystemNotification_UpdatedOn': '2025-12-31T23:59',
        'orderBy': 'UpdatedOn',
        'dir': 1 // Descending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Response

200

SystemNotification[]

The list of SystemNotification records matching the query. See the Get one SystemNotification endpoint for the full list of properties returned for each record.

Partial records — The listing endpoint returns a summary representation of each SystemNotification. The following fields are not populated in the Records[] response: ResolvedOn.To get all fields, fetch the full record using the Get one SystemNotification endpoint.Important for updates: When updating a record via PUT, always retrieve the full record with a GET request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a PUT request, as missing fields may be unintentionally cleared.

integer

Current page number.

integer

Number of records per page.

string

The field used for sorting.

integer

The sort direction (0 = ascending, 1 = descending).

integer

Index of the first item on the current page.

integer

Index of the last item on the current page.

integer

Total number of matching records across all pages.

integer

Total number of pages.

boolean

Whether there is a next page of results.

boolean

Whether there is a previous page of results.

Example Response

{
  "Records": [
    {
      "Title": "",
      "Severity": 0,
      "StartTime": "2025-01-15T10:30:00Z",
      "PublishOn": null,
      "UnPublishOn": null,
      "ShortDescription": "",
      "Description": "",
      "ResolutionDescription": null,
      "Resolved": false,
      "DisplayToAdmins": false,
      "DisplayToSettingIntegrations": null,
      "DisplayToSettingGeneral": null,
      "DisplayToPortalVersion": null,
      "ApprovedBy": null,
      "ApprovedOn": null,
      "MessageType": 0,
      "HasButton": false,
      "ButtonLabel": null,
      "ButtonUrl": null,
      "Id": 87654321,
      "UpdatedOn": "2025-01-15T10:30:00Z",
      "CreatedOn": "2025-01-10T08:00:00Z",
      "UniqueId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "UpdatedBy": "admin@example.com",
      "IsNew": false,
      "SystemId": null,
      "ToStringText": "SystemNotification Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "Title",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}

Get one SystemNotificationRetrieve a single SystemNotification record by its Id.

Search SystemNotifications

curl --request GET \
  --url https://spaces.nexudus.com/api/sys/systemnotifications \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/sys/systemnotifications"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/sys/systemnotifications', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Enums

Query Parameters

Filters

Range Filters

Code Examples

Simple listing

Filtering by Title

Range filters

Response

200

​Authentication

​Enums

​Query Parameters

​Pagination & Sorting

​Filters

​Range Filters

​Code Examples

​Simple listing

​Filtering by Title

​Range filters

​Response

​200

Authentication

Enums

Query Parameters

Pagination & Sorting

Filters

Range Filters

Code Examples

Simple listing

Filtering by Title

Range filters

Response

200