Get Logs

get

https://example.com/v1/admin/logs

Returns a paginated, filterable list of audit log entries scoped to the authenticated client. Supports filtering by time range, severity, system, actor, type, and arbitrary metadata fields. Results are sorted by -created_at by default.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

from

date-time

Return logs with createdAt greater than or equal to this timestamp (RFC 3339). Range filter — use instead of createdAt when you need a lower bound.

date-time

Return logs with createdAt less than or equal to this timestamp (RFC 3339). Range filter — use instead of createdAt when you need an upper bound.

severity_min

integer

Return logs with severity greater than or equal to this value. Range filter.

severity_max

integer

Return logs with severity less than or equal to this value. Range filter.

uuid

Filter by log entry identifier. Supports exact match or repeated parameter for an IN list.

parentId

uuid

Filter by parent log entry identifier. Supports exact match or repeated parameter for an IN list.

system

string

Filter by system name. Supports exact match, repeated parameter for an IN list, or wildcard pattern using * (e.g. *payments*).

type

string

Filter by event type. Supports exact match, repeated parameter for an IN list, or wildcard pattern using * (e.g. user.*).

name

string

Filter by event name. Supports exact match, repeated parameter for an IN list, or wildcard pattern using *.

description

string

Filter by event description. Supports exact match or wildcard pattern using *.

actorId

string

Filter by actor identifier. Supports exact match, repeated parameter for an IN list, or wildcard pattern using *.

actorClientId

string

Filter by actor client identifier. Supports exact match, repeated parameter for an IN list, or wildcard pattern using *.

severity

integer

Filter by exact severity value. Supports repeated parameter for an IN list. For range filtering use severity_min / severity_max instead.

createdAt

date-time

Filter by exact creation timestamp (RFC 3339). For range filtering use from / to instead.

metadata.<key>

string

Filter on a nested field within the metadata JSONB object using dot notation (e.g. metadata.orderId=abc). Supports exact match or wildcard pattern using *. Multiple levels of nesting are supported (e.g. metadata.payment.currency=USD).

actorMetadata.<key>

string

Filter on a nested field within the actorMetadata JSONB object using dot notation (e.g. [email protected]). Supports exact match or wildcard pattern using *. Multiple levels of nesting are supported.

sort

array of strings

Defaults to -created_at

Sort expression(s). Prefix a field name with - for descending order (e.g. -created_at, severity). Repeatable.

sort

size

integer

1 to 100

Defaults to 20

Number of items per page.

page

integer

≥ 0

Defaults to 0

Zero-based page number.

Responses

Language

Credentials

Bearer

JWT

URL

Loading…

Response

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

application/json

200Paginated list of audit logs.

400Bad Request — invalid query parameter value (e.g. size out of range).

401Unauthorized — missing or invalid JWT bearer token.

403Forbidden — authenticated user does not hold the required AUDITLOGSLOGREAD role.

500Internal Server Error.