> ## Documentation Index
> Fetch the complete documentation index at: https://learn.nexudus.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Search CoworkerNotifications

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

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

<Note>
  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.
</Note>

## Query Parameters

### Pagination & Sorting

<ParamField query="page" type="integer" default="1">
  The page number to retrieve.
</ParamField>

<ParamField query="size" type="integer" default="25">
  The number of records per page.
</ParamField>

<ParamField query="orderBy" type="string">
  The property name to sort results by (e.g. `Name`, `CreatedOn`).
</ParamField>

<ParamField query="dir" type="integer">
  Sort direction. `0` for ascending, `1` for descending.
</ParamField>

### Filters

<ParamField query="CoworkerNotification_Coworker" type="integer">
  Filter by Coworker Id.
</ParamField>

<ParamField query="CoworkerNotification_Message" type="string">
  Filter by the notification message body displayed to the coworker.
</ParamField>

<ParamField query="CoworkerNotification_NotificationType" type="string">
  Filter by the type of event that triggered this notification (e.g. blog, community-event, coworkerinvoice, push-notification).
</ParamField>

<ParamField query="CoworkerNotification_EntityId" type="integer">
  Filter by the ID of the entity related to this notification (e.g. the blog post, invoice, or thread that triggered it).
</ParamField>

<ParamField query="CoworkerNotification_IsDismissed" type="boolean">
  Filter by whether the coworker has dismissed this notification.
</ParamField>

### Range Filters

<ParamField query="from_CoworkerNotification_EntityId" type="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.
</ParamField>

<ParamField query="to_CoworkerNotification_EntityId" type="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.
</ParamField>

<ParamField query="from_CoworkerNotification_CreatedOn" type="string">
  Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="to_CoworkerNotification_CreatedOn" type="string">
  Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="from_CoworkerNotification_UpdatedOn" type="string">
  Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="to_CoworkerNotification_UpdatedOn" type="string">
  Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

## Code Examples

### Simple listing

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/spaces/coworkernotifications?page=1&size=15&orderBy=Message&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/spaces/coworkernotifications?' + new URLSearchParams({
      page: 1,
      size: 15,
      orderBy: 'Message',
      dir: 1 // Ascending
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/spaces/coworkernotifications',
      params={
          'page': 1,
          'size': 15,
          'orderBy': 'Message',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Filtering by Message

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/spaces/coworkernotifications?CoworkerNotification_Message=example-value&orderBy=Message&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/spaces/coworkernotifications?' + new URLSearchParams({
      CoworkerNotification_Message: 'example-value',
      orderBy: 'Message',
      dir: 1
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/spaces/coworkernotifications',
      params={
          'CoworkerNotification_Message': 'example-value',
          'orderBy': 'Message',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Range filters

<CodeGroup>
  ```bash cURL theme={null}
  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"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/spaces/coworkernotifications?' + new URLSearchParams({
      from_CoworkerNotification_UpdatedOn: '2025-01-01T00:00',
      to_CoworkerNotification_UpdatedOn: '2025-12-31T23:59',
      orderBy: 'UpdatedOn',
      dir: 1 // Descending
     }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/spaces/coworkernotifications',
      params={
          'from_CoworkerNotification_UpdatedOn': '2025-01-01T00:00',
          'to_CoworkerNotification_UpdatedOn': '2025-12-31T23:59',
          'orderBy': 'UpdatedOn',
          'dir': 1 // Descending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Records" type="CoworkerNotification[]">
  The list of CoworkerNotification records matching the query. See the [Get one CoworkerNotification](/rest-api/spaces/get-coworkernotifications-by-id) endpoint for the full list of properties returned for each record.
</ResponseField>

<ResponseField name="CurrentPage" type="integer">
  Current page number.
</ResponseField>

<ResponseField name="CurrentPageSize" type="integer">
  Number of records per page.
</ResponseField>

<ResponseField name="CurrentOrderField" type="string">
  The field used for sorting.
</ResponseField>

<ResponseField name="CurrentSortDirection" type="integer">
  The sort direction (`0` = ascending, `1` = descending).
</ResponseField>

<ResponseField name="FirstItem" type="integer">
  Index of the first item on the current page.
</ResponseField>

<ResponseField name="LastItem" type="integer">
  Index of the last item on the current page.
</ResponseField>

<ResponseField name="TotalItems" type="integer">
  Total number of matching records across all pages.
</ResponseField>

<ResponseField name="TotalPages" type="integer">
  Total number of pages.
</ResponseField>

<ResponseField name="HasNextPage" type="boolean">
  Whether there is a next page of results.
</ResponseField>

<ResponseField name="HasPreviousPage" type="boolean">
  Whether there is a previous page of results.
</ResponseField>

```json Example Response theme={null}
{
  "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": "admin@example.com",
      "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
}
```