Search CoworkerNotifications

Search and list CoworkerNotification records with filtering, sorting, and pagination.

GET /api/spaces/coworkernotifications

Search CoworkerNotifications

cURL

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

200

{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

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-List role.

Query Parameters

Pagination & Sorting

page · integer · default: "1"

The page number to retrieve.

size · integer · default: "25"

The number of records per page.

orderBy · string

The property name to sort results by (e.g. Name, CreatedOn).

dir · integer

Sort direction. 0 for ascending, 1 for descending.

Filters

CoworkerNotification_Coworker · integer

Filter by iD of the coworker linked to this record.

CoworkerNotification_Message · string

Filter by the notification message body displayed to the coworker.

CoworkerNotification_NotificationType · string

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

CoworkerNotification_EntityId · integer

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

CoworkerNotification_IsDismissed · boolean

Filter by whether the coworker has dismissed this notification.

Range Filters

from_CoworkerNotification_EntityId · integer

Filter by the ID of the entity related to this notification (e.g. the blog post, invoice, or thread that triggered it) greater than or equal to this value.

to_CoworkerNotification_EntityId · integer

Filter by the ID of the entity related to this notification (e.g. the blog post, invoice, or thread that triggered it) less than or equal to this value.

from_CoworkerNotification_CreatedOn · string

Filter records created on or after this date. Format: YYYY-MM-DDTHH:mm.

to_CoworkerNotification_CreatedOn · string

Filter records created on or before this date. Format: YYYY-MM-DDTHH:mm.

from_CoworkerNotification_UpdatedOn · string

Filter records updated on or after this date. Format: YYYY-MM-DDTHH:mm.

to_CoworkerNotification_UpdatedOn · string

Filter records updated on or before this date. Format: YYYY-MM-DDTHH:mm.

Code Examples

Simple listing

cURL

curl -X GET \
  "https://spaces.nexudus.com/api/spaces/coworkernotifications?page=1&size=15&orderBy=Message&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

Filtering by Message

cURL

curl -X GET \
  "https://spaces.nexudus.com/api/spaces/coworkernotifications?CoworkerNotification_Message=example-value&orderBy=Message&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

Range filters

cURL

curl -X GET \
  "https://spaces.nexudus.com/api/spaces/coworkernotifications?from_CoworkerNotification_UpdatedOn=2025-01-01T00:00&to_CoworkerNotification_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

200

Records · CoworkerNotification[]

The list of CoworkerNotification records matching the query. See the Get one CoworkerNotification endpoint for the full list of properties returned for each record.

CurrentPage · integer

Current page number.

CurrentPageSize · integer

Number of records per page.

CurrentOrderField · string

The field used for sorting.

CurrentSortDirection · integer

The sort direction (0 = ascending, 1 = descending).

FirstItem · integer

Index of the first item on the current page.

LastItem · integer

Index of the last item on the current page.

TotalItems · integer

Total number of matching records across all pages.

TotalPages · integer

Total number of pages.

HasNextPage · boolean

Whether there is a next page of results.

HasPreviousPage · boolean

Whether there is a previous page of results.

Example Response

{
  "Records": [
    {
      "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": "[e-mail]",
      "IsNew": false,
      "SystemId": null,
      "ToStringText": "CoworkerNotification Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "Message",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}