Document AI — DMS

List Legal Holds

List active legal holds in the account with document references, reason, and hold timestamps. Read-only for auditors with list permission; does not modify holds.

get/documents/document-legal-holds-list

Request

  • Base URL: https://api.paperoffice.ai/latest
  • URL: https://api.paperoffice.ai/latest/documents/document-legal-holds-list
  • Auth: HTTP bearer

Query parameters

workspace_idinteger

Workspace ID to filter holds. Omit both workspace_id and pofid to list ALL legal holds account-wide (compliance mode).

pofidstring

PaperOffice File ID to filter holds for a specific document. Omit both workspace_id and pofid for account-wide listing.

active_only'0' | '1'

Only aktive Holds (default: 1)

Response

Success

processing_timestring
scopestring
statusstring
totalinteger

Changes

No recorded changes to this operation across all 1 revision of this API.