Get one SystemNotification

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>'

import requests

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

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/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "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

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"

const response = await fetch(
  'https://spaces.nexudus.com/api/sys/systemnotifications/87654321',
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const record = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/sys/systemnotifications/87654321',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

record = response.json()

Response

200

string

The title value for this system notification.

integer

The severity value for this system notification. See eSystemNotificationSeverity enum values: 1 = Low, 2 = Medium, 3 = High.

string

Date/time value for start time.

string

Date/time value for publish on.

string

Date/time value for un publish on.

string

The short description value for this system notification.

string

Free-text description of this system notification.

string

The resolution description value for this system notification.

boolean

Whether resolved is enabled.

string

Date/time value for resolved on.

boolean

Whether display to admins is enabled.

string

The display to setting integrations value for this system notification.

string

The display to setting general value for this system notification.

string

The display to portal version value for this system notification.

string

The approved by value for this system notification.

string

Date/time value for approved on.

integer

The message type value for this system notification. See eSystemNotificationMessageType enum values: 1 = Issue, 2 = Announcement.

boolean

Whether has button is enabled.

string

The button label value for this system notification.

string

The button url value for this system notification.

integer

Unique record identifier.

string

UUID of the record.

string

Date and time the record was created (ISO 8601).

string

Date and time the record was last updated (ISO 8601).

string

Email of the user who last updated this record.

boolean

Whether the record was recently created.

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
}

Get multiple SystemNotificationsRetrieve multiple SystemNotification records by their Ids in a single request.

Get one SystemNotification

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

import requests

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

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/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "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>"
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Path Parameters

Code Examples

Response

200

​Authentication

​Path Parameters

​Code Examples

​Response

​200

Authentication

Path Parameters

Code Examples

Response

200