Get one CoworkerNotification

GET

api

spaces

coworkernotifications

{id}

Get one CoworkerNotification

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

import requests

url = "https://spaces.nexudus.com/api/spaces/coworkernotifications/{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/spaces/coworkernotifications/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

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

NotificationType	Meaning
`blog`	New blog post published
`community-event`	Community event update
`community-message`	New community message
`community-thread`	New community thread
`course`	Course update
`coworkerinvoice`	New invoice generated
`identitycheck-fail`	Identity check failed
`identity-check-failed`	Identity check failed (alternate)
`identity-check-success`	Identity check succeeded
`identitycheck-success`	Identity check succeeded (alternate)
`push-notification`	Generic push notification
`reply-like`	Someone liked a reply
`salto-locker`	Salto locker event
`survey`	Survey notification
`thread-like`	Someone 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

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"

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

const record = await response.json();

import requests

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

record = response.json()

Response

200

integer

ID of the coworker linked to this record.

string

The notification message body displayed to the coworker.

string

The type of event that triggered this notification (e.g. blog, community-event, coworkerinvoice, push-notification).

integer

The ID of the entity related to this notification (e.g. the blog post, invoice, or thread that triggered it).

boolean

Whether the coworker has dismissed this 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

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

Get multiple CoworkerNotificationsRetrieve multiple CoworkerNotification records by their Ids in a single request.

Get one CoworkerNotification

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

import requests

url = "https://spaces.nexudus.com/api/spaces/coworkernotifications/{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/spaces/coworkernotifications/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "CoworkerId": 123,
  "Message": "<string>",
  "NotificationType": "<string>",
  "EntityId": 123,
  "IsDismissed": true,
  "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