> ## 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 CoworkerMessages

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

A message sent to or received from a customer. These can be sent using the default email settings associated with the location or via any of the connected email accounts.

Messages can be composed directly from a customer's record in the Admin Panel. Use `Incoming` to distinguish messages received from a customer from messages sent to them.

## 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 **`CoworkerMessage-List`** role.
</Note>

## Enums

<Accordion title="eBusinessMessageName">
  | Value | Name                                |
  | ----- | ----------------------------------- |
  | 0     | ResetPassword                       |
  | 1     | PaidInvoice                         |
  | 2     | UnPaidInvoice                       |
  | 3     | NewInvoice                          |
  | 4     | PreauthSignUp                       |
  | 5     | NewUser                             |
  | 6     | NewContact                          |
  | 7     | BookingConfirmation                 |
  | 8     | BookingReminder                     |
  | 9     | LowTimePasses                       |
  | 10    | AutoCheckout                        |
  | 11    | EventProduct                        |
  | 12    | TermsAndConditionsAgreed            |
  | 13    | NewEventComment                     |
  | 14    | NewBlogComment                      |
  | 15    | NewCreditNote                       |
  | 16    | NewWallMessage                      |
  | 17    | NewDataFile                         |
  | 18    | NewEsignedFile                      |
  | 19    | VisitorCheckin                      |
  | 20    | VisitorRegistered                   |
  | 21    | ReferralInvite                      |
  | 22    | HelpDeskReply                       |
  | 23    | TourRegistered                      |
  | 24    | SignupRestore                       |
  | 25    | BookingTerminationConfirmation      |
  | 26    | DeliveryReceived                    |
  | 27    | Proposal                            |
  | 28    | BookingDeletedConfirmation          |
  | 29    | PasswordChanged                     |
  | 30    | EventAttendeeCancelledConfirmation  |
  | 31    | VisitorBookingNotification          |
  | 32    | EventUpdateNotification             |
  | 33    | EventAttendeeReminder               |
  | 34    | SurveyInvitation                    |
  | 35    | VisitorBookingCancelledNotification |
  | 36    | BrivoOnAirCode                      |
  | 37    | EventAttendeeEventFinished          |
  | 38    | PinReminder                         |
  | 39    | FormPageInvitation                  |
</Accordion>

## 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="CoworkerMessage_Coworker" type="integer">
  Filter by customer sending or receiving the message.
</ParamField>

<ParamField query="CoworkerMessage_Coworker_FullName" type="string">
  Filter by customer full name.
</ParamField>

<ParamField query="CoworkerMessage_Coworker_Email" type="string">
  Filter by customer email address.
</ParamField>

<ParamField query="CoworkerMessage_Coworker_BillingName" type="string">
  Filter by customer billing name.
</ParamField>

<ParamField query="CoworkerMessage_Coworker_CompanyName" type="string">
  Filter by customer company name.
</ParamField>

<ParamField query="CoworkerMessage_EmailAccount" type="integer">
  Filter by email account used to send or receive the message. If not set, the default email settings configured for the location are used.
</ParamField>

<ParamField query="CoworkerMessage_EmailAccount_DisplayName" type="string">
  Filter by email account display name.
</ParamField>

<ParamField query="CoworkerMessage_EmailAccount_EmailAddress" type="string">
  Filter by email account email address.
</ParamField>

<ParamField query="CoworkerMessage_Subject" type="string">
  Filter by message subject.
</ParamField>

<ParamField query="CoworkerMessage_Body" type="string">
  Filter by message body.
</ParamField>

<ParamField query="CoworkerMessage_IsNewMessage" type="boolean">
  Filter by whether the message has not been read yet.
</ParamField>

<ParamField query="CoworkerMessage_Incoming" type="boolean">
  Filter by whether the message was received from the customer (true) or sent to the customer (false).
</ParamField>

<ParamField query="CoworkerMessage_MessageId" type="integer">
  Filter by automated message template that triggered this message, if sent by the system.
</ParamField>

<ParamField query="CoworkerMessage_ReminderUniqueId" type="string">
  Filter by unique identifier of the reminder that triggered this message, if any.
</ParamField>

### Range Filters

<ParamField query="from_CoworkerMessage_MessageId" type="integer">
  Filter by automated message template that triggered this message, if sent by the system greater than or equal to this value.
</ParamField>

<ParamField query="to_CoworkerMessage_MessageId" type="integer">
  Filter by automated message template that triggered this message, if sent by the system less than or equal to this value.
</ParamField>

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

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

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

<ParamField query="to_CoworkerMessage_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/coworkermessages?page=1&size=15&orderBy=CreatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/spaces/coworkermessages?' + new URLSearchParams({
      page: 1,
      size: 15,
      orderBy: 'CreatedOn',
      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/coworkermessages',
      params={
          'page': 1,
          'size': 15,
          'orderBy': 'CreatedOn',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

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

### Filtering by CreatedOn

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

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/spaces/coworkermessages?' + new URLSearchParams({
      CoworkerMessage_CreatedOn: 'example-value',
      orderBy: 'CreatedOn',
      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/coworkermessages',
      params={
          'CoworkerMessage_CreatedOn': 'example-value',
          'orderBy': 'CreatedOn',
          '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/coworkermessages?from_CoworkerMessage_UpdatedOn=2025-01-01T00:00&to_CoworkerMessage_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/coworkermessages?' + new URLSearchParams({
      from_CoworkerMessage_UpdatedOn: '2025-01-01T00:00',
      to_CoworkerMessage_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/coworkermessages',
      params={
          'from_CoworkerMessage_UpdatedOn': '2025-01-01T00:00',
          'to_CoworkerMessage_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="CoworkerMessage[]">
  The list of CoworkerMessage records matching the query. See the [Get one CoworkerMessage](/rest-api/spaces/get-coworkermessages-by-id) endpoint for the full list of properties returned for each record.
</ResponseField>

<Warning>
  **Partial records** — The listing endpoint returns a summary representation of each CoworkerMessage. The following fields are **not populated** in the `Records[]` response: `Body`.

  To get all fields, fetch the full record using the [Get one CoworkerMessage](/rest-api/spaces/get-coworkermessages-by-id) endpoint.

  **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a `PUT` request, as missing fields may be unintentionally cleared.
</Warning>

<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,
      "CoworkerFullName": null,
      "CoworkerEmail": null,
      "CoworkerBillingName": null,
      "CoworkerCompanyName": null,
      "EmailAccountId": null,
      "EmailAccountDisplayName": null,
      "EmailAccountEmailAddress": null,
      "Subject": null,
      "IsNewMessage": false,
      "Incoming": false,
      "MessageId": 0,
      "ReminderUniqueId": null,
      "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": "CoworkerMessage Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "CreatedOn",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}
```