Sign in
file-search

List Documents V3

List the documents in a collection (v3 parity with GET /v2/collections/{name}/documents). With metadata_filter, one call maps an identifier from your own system to the Captain document, using the same filter grammar as query; pass include_custom_metadata=true to include each document's custom_metadata.

get/v3/collections/{collection_name}/documents

Path parameters

collection_namestring required

Query parameters

limitinteger
offsetinteger
include_custom_metadataboolean

Include each document's custom_metadata. Default false: a page can return up to 1000 documents and each metadata object can be up to 40KB, so this is opt-in rather than riding along by default.

metadata_filterstring nullable

JSON filter over custom_metadata, using the SAME grammar as query filters ($eq/$ne/$gt/$gte/$lt/$lte/$in/$nin/$exists/$and/$or, implicit $eq). Reverse lookup: which Captain document carries your ID, e.g. {"payna_file_id": "doc_18842"}.

Response

Successful Response

collection_namestring required
limitinteger required
offsetinteger required
total_countinteger required

Changes