PHphilterd
Documents

List documents submitted for async redaction.

Changed on

Lists the caller's submitted documents, whatever their status, each with its type, file name, status, submission time, and policy. q filters to documents whose document ID or file name contains it, ignoring case; status filters by status. Requires the documents:read scope.

get/api/documents

Request

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

Query parameters

ownerstring
statusstring
qstring
sortstring
orderstring
offsetinteger
limitinteger

Headers

Authorizationstring required

Response

OK

totalinteger

Changes

  • ef9cc7d72d3bRevision changes
    • info

      added the new optional query request parameter q

  • c715ad02bcdbRevision changes
    • warning

      removed the optional property from the response with the status

    • info

      added the optional property to the response with the status