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 and by metadata, and the status filter finds versions whose processing is not complete.
Permissions. Read on the pipeline.
API conventions describes pagination, field filters and ordering, and Filter operators describes the metadata filter.
Request
Responses
- 200
- 400
- 401
- 404
The body is one page of document versions in the list envelope.
A query parameter is invalid: as_of lies outside the range of valid timestamps (Invalid version), order_by names another field (Invalid order_by parameter) or the pagination parameters conflict (Pagination error). A metadata filter that does not match the pipeline's metadata schema returns Schema error.
The authentication headers are missing or invalid, or the API key is inactive or expired. Errors lists the messages.
No pipeline with this identifier exists, or the key lacks read permission on the pipeline (Pipeline with id <id> not found).