List audit events

get

https://api.qfp.quantnetwork.net/api/audit/events

Returns one page of the calling organisation's events, newest first
(occurredAt,desc; page defaults to 0, size to 20, capped at
100).

Filters are optional and combine with AND. actorIds may be repeated
or comma-separated and matches any of them; the other filters are
exact matches. query is a case-insensitive prefix search across
identifier fields only, never the event payload.

Rows carry changedFields (names only, no values) and
actor.displayName, resolved at read time and null when the lookup
does not resolve.

Query Params

occurredFrom

date-time

Inclusive lower bound on occurredAt, the producer's clock at emit rather than the time the event was recorded. ISO 8601, or the legacy yyyy-MM-dd HH:mm:ss.SSS form.

occurredTo

date-time

Inclusive upper bound on occurredAt. Must not be earlier than occurredFrom, which is a 400 rather than a silently empty page.

actorIds

array of strings

Match any of these actor ids. Repeat the parameter (?actorIds=a&actorIds=b) or give it once comma-separated (?actorIds=a,b). Matching is exact.

actorIds

requestId

string

length ≤ 128

Exact match on the correlation id of the originating request, for following one request across the platform. Events emitted by unattended work carry none.

action

string

length ≤ 50

Exact match on the verb, e.g. CREATE, UPDATE, DELETE, READ, LOGIN, LOGIN_FAILED, APPROVED. The list is open, so an unrecognised value is not an error; it simply matches nothing.

source

string

length ≤ 100

Exact match on the component that emitted the event.

resourceType

string

length ≤ 100

Exact match on the kind of thing the event was about.

resourceId

string

length ≤ 128

Exact match on one instance, giving the history of a single record. Events that name no single instance, such as a login, carry none.

query

string

length ≤ 128

Case-insensitive prefix search across identifier fields only (requestId, resource.id and actor.id), plus an exact match on the event id when the value parses as a whole UUID. It never searches the event payload. A fragment from the middle of an identifier does not match.

page

int32

≥ 0

Defaults to 0

Zero-based page index. Defaults to 0.

size

int32

1 to 100

Defaults to 20

Page size. Defaults to 20. A larger value is capped at 100 without an error, so read the size on the response.

sort

string

Sort order as property,direction, e.g. occurredAt,desc. Repeatable. Defaults to occurredAt,desc. Sortable properties: occurredAt, createdAt, action, category, source, actorId, resourceType, resourceId, outcome. Anything else returns 400.

Headers

API-Version

string

required

^\d+\.\d+\.\d+$

The version of the Quant Flow API the request follows, as major.minor.patch (for example 1.0.0). The request is interpreted, and the response shaped, according to that version.

Responses

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200One page of matching events, newest first. An organisation with no matching events gets an empty data array, not a 404.

400A filter or paging parameter the service will not accept: an inverted occurredAt range, a property outside the sortable allow-list, a query longer than 128 characters, or a date that does not parse.

401The bearer token is missing, unparsable, or lacks the sub or tenant_id claim.