PHphilterd
Legal Holds

List legal holds.

Changed on

Returns the caller's active legal holds, paged and ordered by set date descending. Admins may list another user's holds via the owner parameter, or every user's with all_users=true, which adds each hold's owner and requires ADMIN_CROSS_USER_ACCESS_ENABLED. Requires the holds:read scope.

get/api/holds

Request

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

Query parameters

ownerstring
all_usersboolean
qstring
sortstring
orderstring
offsetinteger
limitinteger

Headers

Authorizationstring required

Response

A page of legal holds in holds, most recently set first by default, and the total. With all_users, each hold also has an owner field.

totalinteger

How many holds the listing has across every page.

Changes

  • 92f2a1031445Revision changes
    • info

      added the optional property // to the response with the status

  • c4f85daa9208Revision changes
    • 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

    • info

      added the optional property to the response with the status