List vault objects
Retrieve the objects stored in a specific vault, oldest first, including document metadata, ingestion status, and processing statistics. Pass limit to page through large vaults: when pagination.has_more is true, the response is incomplete and pagination.next_cursor fetches the rest.
Authorizations
API key starting with sk_case_
Path Parameters
The unique identifier of the vault
Query Parameters
Include placeholders for uploads that were never completed (awaiting_upload) or were cancelled (aborted). Excluded by default.
JSON-encoded provenance object used as a partial match. For example, {"provider":"clio"} returns objects whose file_origin contains that value.
"{\"provider\":\"clio\"}"
Objects per page (1-200). Omit to receive every object. Supplying a cursor without a limit uses 50.
1 <= x <= 200Opaque continuation cursor from pagination.next_cursor of the previous page. Must be replayed with the same API key scope and the same query, file_origin and includeUnconfirmed values that produced it.
Case-insensitive substring match on the filename.
When true, adds totals covering every object matching the filters, not just this page. Request it once per filter change rather than on every page.
Response
Successfully retrieved vault objects
The ID of the vault
Number of objects in this response. Equals the vault total only when pagination.has_more is false; use totals.objects for the total across pages.
Present only with include_totals=true. Covers every object matching the filters, across all pages.