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

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

A **LogEntry** records a system event or error for diagnostic and auditing purposes. Log entries are categorised by type (error, warning, information, payment error, integration error, etc.) and linked to the business where they occurred.

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

## Enums

<Accordion title="eLogEntryType — LogEntryType values">
  | Value | Name                   |
  | ----- | ---------------------- |
  | 1     | Error                  |
  | 2     | Warning                |
  | 3     | Information            |
  | 4     | InvoicingError         |
  | 5     | PaymentError           |
  | 6     | IntegrationError       |
  | 7     | AccessIntegrationError |
  | 99    | Other                  |
</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="LogEntry_Business" type="integer">
  Filter by iD of the business linked to this record.
</ParamField>

<ParamField query="LogEntry_LogEntryType" type="integer">
  Filter by the log entry type value for this log entry.
</ParamField>

<ParamField query="LogEntry_Description" type="string">
  Filter by free-text description of this log entry.
</ParamField>

<ParamField query="LogEntry_ActionBy" type="string">
  Filter by the action by value for this log entry.
</ParamField>

<ParamField query="LogEntry_EntityName" type="string">
  Filter by the entity name value for this log entry.
</ParamField>

<ParamField query="LogEntry_EntityId" type="integer">
  Filter by iD of the entity associated with this record.
</ParamField>

<ParamField query="LogEntry_Obsolete" type="boolean">
  Filter by whether obsolete is enabled.
</ParamField>

### Range Filters

<ParamField query="from_LogEntry_EntityId" type="integer">
  Filter by iD of the entity associated with this record greater than or equal to this value.
</ParamField>

<ParamField query="to_LogEntry_EntityId" type="integer">
  Filter by iD of the entity associated with this record less than or equal to this value.
</ParamField>

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

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

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

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

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

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

### Filtering by Description

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

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

  To get all fields, fetch the full record using the [Get one LogEntry](/rest-api/sys/get-logentries-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,
      "LogEntryType": 0,
      "Description": "",
      "ActionBy": 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": "LogEntry Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "Description",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}
```