Legal Holds

Get a legal hold.

Changed on Oct 10, 2026

Returns the hold with the given reference. Admins may retrieve another user's hold via the owner parameter. Requires the holds:read scope.

get/api/holds/{reference}

Request

Base URL
/ (relative, and the document was published on a file host, not at the API’s origin)
URL
/api/holds/{reference}
Auth
HTTP bearer

Path parameters

referencestring required

Query parameters

ownerstring

Headers

Authorizationstring required

Response

The hold details.

reasonstring

referencestring

scopeTypestring

scopeValuestring

setAtstring date-time

Changes

Oct 10, 2026c4f85daa9208 Revision changes
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
Oct 5, 20264082c17721d8 Revision changes
- breaking
  removed the media type */* for the response with the status
- breaking
  removed the media type */* for the response with the status
- breaking
  removed the media type */* for the response with the status
- breaking
  removed the media type */* for the response with the status
- breaking
  removed the media type */* for the response with the status
- breaking
  removed the media type */* for the response with the status
- info
  added the media type application/json for the response with the status
- info
  added the media type application/json for the response with the status
- info
  added the media type application/json for the response with the status
- info
  added the media type application/json for the response with the status
- info
  added the media type application/json for the response with the status
- info
  added the media type application/json for the response with the status

Operation history (5 revisions)