Skip to main content
GET
/
api
/
spaces
/
coworkernotifications
/
{id}
{
  "CoworkerId": 123,
  "Message": "<string>",
  "NotificationType": "<string>",
  "EntityId": 123,
  "IsDismissed": true,
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}
A CoworkerNotification represents a push notification sent to a customer (coworker). Notifications are generated by the system in response to various events such as new blog posts, community messages, invoices, identity checks, and more. Notifications are read-only — they can be listed and retrieved but not created or modified via the API. The NotificationType field indicates the source event. Common values include:
NotificationTypeMeaning
blogNew blog post published
community-eventCommunity event update
community-messageNew community message
community-threadNew community thread
courseCourse update
coworkerinvoiceNew invoice generated
identitycheck-failIdentity check failed
identity-check-failedIdentity check failed (alternate)
identity-check-successIdentity check succeeded
identitycheck-successIdentity check succeeded (alternate)
push-notificationGeneric push notification
reply-likeSomeone liked a reply
salto-lockerSalto locker event
surveySurvey notification
thread-likeSomeone liked a thread

​
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 CoworkerNotification-Read role.

​
Path Parameters

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

​
Code Examples

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

​
Response

​
200

​
CoworkerId
integer
Coworker Id.
​
Message
string
The notification message body displayed to the coworker.
​
NotificationType
string
The type of event that triggered this notification (e.g. blog, community-event, coworkerinvoice, push-notification).
​
EntityId
integer
The ID of the entity related to this notification (e.g. the blog post, invoice, or thread that triggered it).
​
IsDismissed
boolean
Whether the coworker has dismissed this 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
{
  "CoworkerId": 0,
  "Message": "",
  "NotificationType": "",
  "EntityId": 0,
  "IsDismissed": false,
  "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": "CoworkerNotification Example",
  "LocalizationDetails": null,
  "CustomFields": null
}