Skip to main content

Workflow audit

Generated from apiome-rest/openapi.yaml (API version 1.204.1) — do not edit by hand. How to authenticate is on the REST API reference.

Tag: workflow-audit · 1 operation

GET /v1/versions/{tenant_slug}/workflow-audit​

List Workflow Audit

List workflow audit events for the tenant (newest first).

Pagination: use offset + limit, or cursor + limit. Do not combine cursor with a non-zero offset.

Operation id: list_workflow_audit_v1_versions__tenant_slug__workflow_audit_get

Parameters

NameInTypeRequiredDescription
tenant_slugpathstringyesURL-safe tenant slug that scopes the request.
actionqueryarray of string or nullnoFilter by action (repeat for multiple, e.g. version.push).
actorIdquerystring or nullnoFilter by actor user id (UUID).
outcomequerystring or nullnoFilter by outcome: success or failure.
versionIdquerystring or nullnoFilter by revision id (versions.id) stored on the audit row.
projectIdquerystring or nullnoRestrict to a project id (UUID); must belong to the tenant.
sincequerystring or nullnoInclusive lower bound on createdAt (ISO 8601).
untilquerystring or nullnoInclusive upper bound on createdAt (ISO 8601).
limitqueryintegernoMaximum number of rows to return.
offsetqueryintegernoNumber of rows to skip before returning results.
cursorquerystring or nullnoOpaque next-page token from pagination.nextCursor (cursor mode).
authorizationheaderstring or nullnoJWT bearer token for authenticated access (Authorization: Bearer <token>).
X-API-Keyheaderstring or nullnoTenant-scoped API key used as an alternative to JWT bearer authentication.

Responses

StatusDescriptionBody
200Successful response for list workflow audit.application/json WorkflowAuditPageResponse
422Validation Errorapplication/json HTTPValidationError

Schemas used​

HTTPValidationError​

Validation error response emitted when request data fails schema checks.

PropertyTypeRequiredDescription
detailarray of ValidationErrornoDetail.

WorkflowAuditPageResponse​

Stable JSON envelope for GET .../workflow-audit (schemaVersion bumps on breaking changes).

PropertyTypeRequiredDescription
schemaVersionintegernoBumped only when item or pagination shape changes incompatibly.
itemsarray of WorkflowAuditEntryOutyesItems.
paginationWorkflowAuditPaginationOutyesPagination.