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

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

An individual message within an admin agent session conversation. Messages can be from the user, assistant, system, or tool calls/results. Each message tracks its role, content, and any tool interactions including tool name, arguments, and results. Token usage is tracked per message for cost monitoring.

## 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 **`AdminAgentMessage-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="AdminAgentMessage_AdminAgentSession" type="integer">
  Filter by iD of the admin agent session linked to this message.
</ParamField>

<ParamField query="AdminAgentMessage_Role" type="integer">
  Filter by role of the message sender: User, Assistant, System, ToolCall, or ToolResult.
</ParamField>

<ParamField query="AdminAgentMessage_Content" type="string">
  Filter by the text content of the message.
</ParamField>

<ParamField query="AdminAgentMessage_ToolName" type="string">
  Filter by name of the tool that was called or produced a result.
</ParamField>

<ParamField query="AdminAgentMessage_ToolArguments" type="string">
  Filter by jSON-formatted arguments passed to the tool.
</ParamField>

<ParamField query="AdminAgentMessage_ToolResult" type="string">
  Filter by jSON-formatted result returned by the tool.
</ParamField>

<ParamField query="AdminAgentMessage_TokensUsed" type="integer">
  Filter by number of LLM tokens consumed by this message.
</ParamField>

<ParamField query="AdminAgentMessage_Author" type="integer">
  Filter by user who wrote the message (people only).
</ParamField>

<ParamField query="AdminAgentMessage_Author_FullName" type="string">
  Filter by display value for Author.FullName..
</ParamField>

<ParamField query="AdminAgentMessage_Author_Email" type="string">
  Filter by display value for Author.Email..
</ParamField>

<ParamField query="AdminAgentMessage_Target" type="integer">
  Filter by agent when the assistant was asked to answer, Chat when the message was for the people in the conversation.
</ParamField>

<ParamField query="AdminAgentMessage_Mentions" type="string">
  Filter by jSON with the users and/or agent mentioned in the message.
</ParamField>

### Range Filters

<ParamField query="from_AdminAgentMessage_TokensUsed" type="integer">
  Filter by number of LLM tokens consumed by this message greater than or equal to this value.
</ParamField>

<ParamField query="to_AdminAgentMessage_TokensUsed" type="integer">
  Filter by number of LLM tokens consumed by this message less than or equal to this value.
</ParamField>

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

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

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

<ParamField query="to_AdminAgentMessage_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/adminagentmessages?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/sys/adminagentmessages?' + 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/sys/adminagentmessages',
      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/sys/adminagentmessages?AdminAgentMessage_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/sys/adminagentmessages?' + new URLSearchParams({
      AdminAgentMessage_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/sys/adminagentmessages',
      params={
          'AdminAgentMessage_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/sys/adminagentmessages?from_AdminAgentMessage_UpdatedOn=2025-01-01T00:00&to_AdminAgentMessage_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/adminagentmessages?' + new URLSearchParams({
      from_AdminAgentMessage_UpdatedOn: '2025-01-01T00:00',
      to_AdminAgentMessage_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/adminagentmessages',
      params={
          'from_AdminAgentMessage_UpdatedOn': '2025-01-01T00:00',
          'to_AdminAgentMessage_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="AdminAgentMessage[]">
  The list of AdminAgentMessage records matching the query. See the [Get one AdminAgentMessage](/rest-api/sys/get-adminagentmessages-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": [
    {
      "AdminAgentSessionId": 0,
      "Role": 0,
      "Content": null,
      "ToolName": null,
      "ToolArguments": null,
      "ToolResult": null,
      "TokensUsed": 0,
      "AuthorId": null,
      "AuthorFullName": null,
      "AuthorEmail": null,
      "Target": 0,
      "Mentions": 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": "AdminAgentMessage 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
}
```