Skip to main content
GET
/
api
/
sys
/
systemnotifications
{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

​
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.

​
Query Parameters

​
Pagination & Sorting

​
page
integer
default:"1"
The page number to retrieve.
​
size
integer
default:"25"
The number of records per page.
​
orderBy
string
The property name to sort results by (e.g. Name, CreatedOn).
​
dir
integer
Sort direction. 1 for ascending, -1 for descending.

​
Filters

​
SystemNotification_Title
string
Filter by Title.
​
SystemNotification_Severity
integer
Filter by Severity.
​
SystemNotification_StartTime
string
Filter by Start Time.
​
SystemNotification_PublishOn
string
Filter by Publish On.
​
SystemNotification_UnPublishOn
string
Filter by Un Publish On.
​
SystemNotification_ShortDescription
string
Filter by Short Description.
​
SystemNotification_Description
string
Filter by Description.
​
SystemNotification_ResolutionDescription
string
Filter by Resolution Description.
​
SystemNotification_Resolved
boolean
Filter by Resolved.
​
SystemNotification_ResolvedOn
string
Filter by Resolved On.
​
SystemNotification_DisplayToAdmins
boolean
Filter by Display To Admins.
​
SystemNotification_DisplayToSettingIntegrations
string
Filter by Display To Setting Integrations.
​
SystemNotification_DisplayToSettingGeneral
string
Filter by Display To Setting General.
​
SystemNotification_DisplayToPortalVersion
string
Filter by Display To Portal Version.
​
SystemNotification_ApprovedBy
string
Filter by Approved By.
​
SystemNotification_ApprovedOn
string
Filter by Approved On.
​
SystemNotification_MessageType
integer
Filter by Message Type.
​
SystemNotification_HasButton
boolean
Filter by Has Button.
​
SystemNotification_ButtonLabel
string
Filter by Button Label.
​
SystemNotification_ButtonUrl
string
Filter by Button Url.

​
Range Filters

​
from_SystemNotification_StartTime
string
Filter by start time greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.
​
to_SystemNotification_StartTime
string
Filter by start time less than or equal to this value. Format: YYYY-MM-DDTHH:mm.
​
from_SystemNotification_PublishOn
string
Filter by publish on greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.
​
to_SystemNotification_PublishOn
string
Filter by publish on less than or equal to this value. Format: YYYY-MM-DDTHH:mm.
​
from_SystemNotification_UnPublishOn
string
Filter by un publish on greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.
​
to_SystemNotification_UnPublishOn
string
Filter by un publish on less than or equal to this value. Format: YYYY-MM-DDTHH:mm.
​
from_SystemNotification_ResolvedOn
string
Filter by resolved on greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.
​
to_SystemNotification_ResolvedOn
string
Filter by resolved on less than or equal to this value. Format: YYYY-MM-DDTHH:mm.
​
from_SystemNotification_ApprovedOn
string
Filter by approved on greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.
​
to_SystemNotification_ApprovedOn
string
Filter by approved on less than or equal to this value. Format: YYYY-MM-DDTHH:mm.
​
from_SystemNotification_CreatedOn
string
Filter records created on or after this date. Format: YYYY-MM-DDTHH:mm.
​
to_SystemNotification_CreatedOn
string
Filter records created on or before this date. Format: YYYY-MM-DDTHH:mm.
​
from_SystemNotification_UpdatedOn
string
Filter records updated on or after this date. Format: YYYY-MM-DDTHH:mm.
​
to_SystemNotification_UpdatedOn
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=1" \
  -H "Authorization: Bearer YOUR_TOKEN"

​
Filtering by Title

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

​
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=-1" \
  -H "Authorization: Bearer YOUR_TOKEN"

​
Response

​
200

​
Records
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 included 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.
​
CurrentPage
integer
Current page number.
​
CurrentPageSize
integer
Number of records per page.
​
CurrentOrderField
string
The field used for sorting.
​
CurrentSortDirection
integer
The sort direction (1 = ascending, -1 = descending).
​
FirstItem
integer
Index of the first item on the current page.
​
LastItem
integer
Index of the last item on the current page.
​
TotalItems
integer
Total number of matching records across all pages.
​
TotalPages
integer
Total number of pages.
​
HasNextPage
boolean
Whether there is a next page of results.
​
HasPreviousPage
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,
      "ResolvedOn": null,
      "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
}