Skip to main content

List documents

GET 

/pipelines/:pipeline_id/documents

Returns one page of the document versions in a pipeline that are current, or that were current at the time given in as_of. A document with several current versions appears once for each version. Query parameters filter the list by document fields, by path and by metadata, and the status filter finds versions whose processing is not complete or has failed. Without path, the list contains only the documents without a path; path=> lists every document that has a path. No single request lists the documents with and without a path together.

Permissions. Read on the pipeline. The list contains only the versions whose classification the classification allow-list of the key covers.

API conventions describes pagination, field filters and ordering, Filter operators describes the metadata filter, and Document paths describes the path patterns.

Request​

Responses​

The body is one page of document versions in the list envelope.