Skip to navigation

List Document Set Audit Trail

View as Markdown

Returns who did what to one document set, newest first: force accepts, withdrawals, system releases and other audited actions. The log is append-only.

Each entry has an action (<category>.<verb>, see List Audit Actions), the actor (a user, or is_system: true), an optional reason, comment or system cause, and the targets it touched with their before and after state.

Page with next_cursor: pass it back as cursor until it is null. counts gives the number of entries per action and ignores the action and category filters, so it can drive filter chips.

Requires reconciliation v2 on the organisation; other tenants receive 404.

Authentication

x-api-keystring
API key issued by Staple.
AuthorizationBearer
JWT obtained from the login endpoint.

Path parameters

idstringRequired

Document set ID (document_set_id from List Document Sets), URL-encoded.

Query parameters

actionlist of stringsOptional

Filter by action, for example force_accept.accepted. Repeat the parameter or pass a comma-separated list. Combined with category by OR.

categorylist of stringsOptional

Filter by action category (the part before the dot), for example force_accept.

fromdatetimeOptional

Only entries at or after this time (ISO 8601 date-time).

todatetimeOptional

Only entries at or before this time (ISO 8601 date-time).

user_idintegerOptional>=1
Only entries performed by this user ID.
cursorstringOptional

next_cursor from the previous page.

limitintegerOptional<=200Defaults to 50
Page size. Defaults to 50 and is capped at 200.

Response

OK