Skip to main content
GET
Error

Authorizations

Authorization
string
header
required

Authorization: Bearer <token>. Accepts EITHER a Keycloak access token (scopes-in-token) OR an opaque POS session token; both resolve to the same pos.* scope vocabulary the route guards enforce.

Query Parameters

page
integer
default:1

1-based page index to return. Defaults to 1.

Required range: 1 <= x <= 9007199254740991
pageSize
integer
default:20

Rows per page, 1..100. Defaults to 20.

Required range: 1 <= x <= 100
actorId
string

Narrow to actions performed by this actor id.

entityType
string

Narrow to a target entity kind (e.g. purchaseOrder, product).

entityId
string

Narrow to actions against one target entity id.

action
string

Narrow to one audited action key (e.g. procurement.createPurchaseOrder).

outcome
string

Narrow to success or failure — the recorded outcome. NOTE: a write that never reached the server leaves NO row at all, so failure means 'the server judged this and refused or broke', never 'the till was offline'.

resultCode
string

Narrow to one recorded ResultCode (VALIDATION_FAILED, UNAUTHORIZED, FORBIDDEN, NOT_FOUND, CONFLICT, BUSINESS_RULE_VIOLATION, INTERNAL_ERROR, OK). This is the facet that separates an authoritative refusal from a server that broke — ?outcome=failure alone lumps them together.

from
string

Lower bound (inclusive) of the audit window, as an ISO-8601 instant.

to
string

Upper bound (inclusive) of the audit window, as an ISO-8601 instant.

Response

One page of the matching audit-log entries, most recent first.

One page of the matching audit-log entries, most recent first.

items
object[]
required

The rows on this page, in the query's sort order.

total
integer
required

Total rows matching the filter across ALL pages, not just this one.

Required range: 0 <= x <= 9007199254740991
page
integer
required

The 1-based page number served.

Required range: 0 < x <= 9007199254740991
pageSize
integer
required

Rows requested per page.

Required range: 0 < x <= 9007199254740991
pageCount
integer
required

Total number of pages; stop walking when page reaches it.

Required range: 0 <= x <= 9007199254740991