Skip to main content
GET
/
api
/
sys
/
systemnotifications
/
{id}
Get one SystemNotification
curl --request GET \
  --url https://spaces.nexudus.com/api/sys/systemnotifications/{id} \
  --header 'Authorization: Basic <encoded-value>'
{
  "Title": "<string>",
  "Severity": 123,
  "StartTime": "<string>",
  "PublishOn": "<string>",
  "UnPublishOn": "<string>",
  "ShortDescription": "<string>",
  "Description": "<string>",
  "ResolutionDescription": "<string>",
  "Resolved": true,
  "ResolvedOn": "<string>",
  "DisplayToAdmins": true,
  "DisplayToSettingIntegrations": "<string>",
  "DisplayToSettingGeneral": "<string>",
  "DisplayToPortalVersion": "<string>",
  "ApprovedBy": "<string>",
  "ApprovedOn": "<string>",
  "MessageType": 123,
  "HasButton": true,
  "ButtonLabel": "<string>",
  "ButtonUrl": "<string>",
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}
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-Read role.

​
Path Parameters

​
id
integer
required
The Id of the SystemNotification record to retrieve.

​
Code Examples

curl -X GET \
  "https://spaces.nexudus.com/api/sys/systemnotifications/87654321" \
  -H "Authorization: Bearer YOUR_TOKEN"

​
Response

​
200

​
Title
string
The title value for this system notification.
​
Severity
integer
The severity value for this system notification. See eSystemNotificationSeverity enum values: 1 = Low, 2 = Medium, 3 = High.
​
StartTime
string
Date/time value for start time.
​
PublishOn
string
Date/time value for publish on.
​
UnPublishOn
string
Date/time value for un publish on.
​
ShortDescription
string
The short description value for this system notification.
​
Description
string
Free-text description of this system notification.
​
ResolutionDescription
string
The resolution description value for this system notification.
​
Resolved
boolean
Whether resolved is enabled.
​
ResolvedOn
string
Date/time value for resolved on.
​
DisplayToAdmins
boolean
Whether display to admins is enabled.
​
DisplayToSettingIntegrations
string
The display to setting integrations value for this system notification.
​
DisplayToSettingGeneral
string
The display to setting general value for this system notification.
​
DisplayToPortalVersion
string
The display to portal version value for this system notification.
​
ApprovedBy
string
The approved by value for this system notification.
​
ApprovedOn
string
Date/time value for approved on.
​
MessageType
integer
The message type value for this system notification. See eSystemNotificationMessageType enum values: 1 = Issue, 2 = Announcement.
​
HasButton
boolean
Whether has button is enabled.
​
ButtonLabel
string
The button label value for this system notification.
​
ButtonUrl
string
The button url value for this system notification.
​
Id
integer
Unique record identifier.
​
UniqueId
string
UUID of the record.
​
CreatedOn
string
Date and time the record was created (ISO 8601).
​
UpdatedOn
string
Date and time the record was last updated (ISO 8601).
​
UpdatedBy
string
Email of the user who last updated this record.
​
IsNew
boolean
Whether the record was recently created.
​
SystemId
string
External system identifier.
Example Response
{
  "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
}