Skip to main content
GET
Search LogEntries
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

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.

Enums

Query Parameters

Pagination & Sorting

integer
default:"1"
The page number to retrieve.
integer
default:"25"
The number of records per page.
string
The property name to sort results by (e.g. Name, CreatedOn).
integer
Sort direction. 0 for ascending, 1 for descending.

Filters

integer
Filter by iD of the business linked to this record.
integer
Filter by the log entry type value for this log entry.
string
Filter by free-text description of this log entry.
string
Filter by the action by value for this log entry.
string
Filter by the entity name value for this log entry.
integer
Filter by iD of the entity associated with this record.
boolean
Filter by whether obsolete is enabled.

Range Filters

integer
Filter by iD of the entity associated with this record greater than or equal to this value.
integer
Filter by iD of the entity associated with this record less than or equal to this value.
string
Filter records created on or after this date. Format: YYYY-MM-DDTHH:mm.
string
Filter records created on or before this date. Format: YYYY-MM-DDTHH:mm.
string
Filter records updated on or after this date. Format: YYYY-MM-DDTHH:mm.
string
Filter records updated on or before this date. Format: YYYY-MM-DDTHH:mm.

Code Examples

Simple listing

Filtering by Description

Range filters

Response

200

LogEntry[]
The list of LogEntry records matching the query. See the Get one LogEntry endpoint for the full list of properties returned for each record.
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 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.
integer
Current page number.
integer
Number of records per page.
string
The field used for sorting.
integer
The sort direction (0 = ascending, 1 = descending).
integer
Index of the first item on the current page.
integer
Index of the last item on the current page.
integer
Total number of matching records across all pages.
integer
Total number of pages.
boolean
Whether there is a next page of results.
boolean
Whether there is a previous page of results.
Example Response