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

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

An **OpenAiChatMessage** records a message in an AI-powered chat conversation. Each message tracks the content, the associated customer or operator, and the action type.

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

## Enums

<Accordion title="eOpenAiChatMessageType — Action values">
  | Value | Name     |
  | ----- | -------- |
  | 1     | Operator |
</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="OpenAiChatMessage_Business" type="integer">
  Filter by iD of the business linked to this record.
</ParamField>

<ParamField query="OpenAiChatMessage_User" type="integer">
  Filter by iD of the user linked to this record.
</ParamField>

<ParamField query="OpenAiChatMessage_AiChannelSession" type="integer">
  Filter by iD of the AI channel session linked to this message. Sessions group all messages in a conversation and link it to a specific user and AI channel (e.g. email, chat, WhatsApp).
</ParamField>

<ParamField query="OpenAiChatMessage_AiChannelSession_ExternalIdentifier" type="string">
  Filter by external identifier of the AI channel session linked to this message. Email address for email sessions, phone number for WhatsApp, etc..
</ParamField>

<ParamField query="OpenAiChatMessage_AiChannelSession_Coworker_Id" type="string">
  Filter by iD of the customer linked to the AI channel session.
</ParamField>

<ParamField query="OpenAiChatMessage_AiChannelSession_Coworker_CoworkerType" type="string">
  Filter by the type of the customer linked to the AI channel session (e.g. Individual or Company).
</ParamField>

<ParamField query="OpenAiChatMessage_AiChannelSession_Coworker_FullName" type="string">
  Filter by full name of the customer linked to the AI channel session.
</ParamField>

<ParamField query="OpenAiChatMessage_AiChannelSession_Coworker_MobilePhone" type="string">
  Filter by mobile phone number of the customer linked to the AI channel session.
</ParamField>

<ParamField query="OpenAiChatMessage_AiChannelSession_Coworker_LandLine" type="string">
  Filter by landline phone number of the customer linked to the AI channel session.
</ParamField>

<ParamField query="OpenAiChatMessage_AiChannelSession_Coworker_BillingName" type="string">
  Filter by billing name of the customer linked to the AI channel session.
</ParamField>

<ParamField query="OpenAiChatMessage_AiChannelSession_Coworker_CompanyName" type="string">
  Filter by company name of the customer linked to the AI channel session (if the customer is a company).
</ParamField>

<ParamField query="OpenAiChatMessage_AiChannelSession_Coworker_TeamNames" type="string">
  Filter by comma-separated list of team names that the customer linked to the AI channel session belongs to.
</ParamField>

<ParamField query="OpenAiChatMessage_Action" type="integer">
  Filter by the action value for this open ai chat message.
</ParamField>

<ParamField query="OpenAiChatMessage_Content" type="string">
  Filter by the content value for this open ai chat message.
</ParamField>

<ParamField query="OpenAiChatMessage_ChatSession" type="string">
  Filter by the chat session value for this open ai chat message.
</ParamField>

<ParamField query="OpenAiChatMessage_ResponderName" type="string">
  Filter by display name of the linked responder (read-only).
</ParamField>

<ParamField query="OpenAiChatMessage_ChatMessageRole" type="string">
  Filter by the chat message role value for this open ai chat message.
</ParamField>

<ParamField query="OpenAiChatMessage_Rating" type="integer">
  Filter by the rating value for this open ai chat message.
</ParamField>

<ParamField query="OpenAiChatMessage_Channel" type="string">
  Filter by the AI channel through which this message was sent (e.g. Email, Chat, WhatsApp).
</ParamField>

### Range Filters

<ParamField query="from_OpenAiChatMessage_Rating" type="integer">
  Filter by the rating value for this open ai chat message greater than or equal to this value.
</ParamField>

<ParamField query="to_OpenAiChatMessage_Rating" type="integer">
  Filter by the rating value for this open ai chat message less than or equal to this value.
</ParamField>

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

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

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

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

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

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

### Filtering by Content

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

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/sys/openaichatmessages?' + new URLSearchParams({
      OpenAiChatMessage_Content: 'example-value',
      orderBy: 'Content',
      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/sys/openaichatmessages',
      params={
          'OpenAiChatMessage_Content': 'example-value',
          'orderBy': 'Content',
          '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/sys/openaichatmessages?from_OpenAiChatMessage_UpdatedOn=2025-01-01T00:00&to_OpenAiChatMessage_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/sys/openaichatmessages?' + new URLSearchParams({
      from_OpenAiChatMessage_UpdatedOn: '2025-01-01T00:00',
      to_OpenAiChatMessage_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/sys/openaichatmessages',
      params={
          'from_OpenAiChatMessage_UpdatedOn': '2025-01-01T00:00',
          'to_OpenAiChatMessage_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="OpenAiChatMessage[]">
  The list of OpenAiChatMessage records matching the query. See the [Get one OpenAiChatMessage](/rest-api/sys/get-openaichatmessages-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 OpenAiChatMessage. The following fields are **not populated** in the `Records[]` response: `Action`.

  To get all fields, fetch the full record using the [Get one OpenAiChatMessage](/rest-api/sys/get-openaichatmessages-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": [
    {
      "BusinessId": 0,
      "UserId": null,
      "AiChannelSessionId": null,
      "AiChannelSessionExternalIdentifier": null,
      "AiChannelSessionCoworkerId": null,
      "AiChannelSessionCoworkerCoworkerType": null,
      "AiChannelSessionCoworkerFullName": null,
      "AiChannelSessionCoworkerMobilePhone": null,
      "AiChannelSessionCoworkerLandLine": null,
      "AiChannelSessionCoworkerBillingName": null,
      "AiChannelSessionCoworkerCompanyName": null,
      "AiChannelSessionCoworkerTeamNames": null,
      "Content": "",
      "ChatSession": null,
      "ResponderName": null,
      "ChatMessageRole": null,
      "Rating": null,
      "Channel": 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": "OpenAiChatMessage Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "Content",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}
```