NUnullplatform
Announcements

Read a notification

Changed on

Returns one of your organization's notifications or announcements.

get/communications/notification/{id}

Request

  • Base URL
    https://api.nullplatform.com
  • URL
    https://api.nullplatform.com/communications/notification/{id}
  • Auth
    HTTP bearer

Path parameters

idstring uuid required

The ID of the notification, as returned when it was created or listed.

Response

The requested notification.

idstring uuid

The ID of the notification.

organization_idinteger

Your organization's ID.

kind'broadcast' | 'personal'
categorystring
severity'informational' | 'maintenance' | 'degraded' | 'outage'
status'open' | 'closed'
nrnstring
titlestring
bodystring nullable
audienceobject nullable
ctaobject nullable
mediaobject nullable
keystring nullable
group_keystring nullable
publisher'nullplatform' | 'organization'

organization for your organization's notifications, and nullplatform for the ones nullplatform sends your organization. Only the status of a nullplatform one can change.

publish_atstring date-time nullable
expires_atstring date-time nullable
closed_atstring date-time nullable
closed_byinteger nullable
created_byinteger

The ID of the user who created it.

created_atstring date-time
updated_atstring date-time

Example response

{
  "id": "6f1c2b9e-3a41-4f0e-9d55-2b7c1e0a9f13",
  "organization_id": 1,
  "kind": "broadcast",
  "category": "platform.maintenance",
  "severity": "maintenance",
  "status": "open",
  "nrn": "organization=1",
  "title": "Scheduled maintenance on Saturday",
  "surfaces": [
    {
      "type": "banner",
      "sections": [
        "development"
      ],
      "dismissible": true
    }
  ],
  "publisher": "organization",
  "created_by": 12345,
  "created_at": "2026-10-27T14:03:11.000Z",
  "updated_at": "2026-10-27T14:03:11.000Z"
}

Changes