Sign in
Documents

Get Document Info List

Retrives a list of document metadata information that matches the provided filters.

The documents returned will be sorted by path in lexicographically ascending order. path_gt can be used for pagination, and should be set to the path of the last document returned in the previous call.

A 404 Not Found will be returned if either the collection name does not exist, or the document path does not exist within the provided collection.

post/documents/get-document-info-list

Request body

collection_namestring required

The name of the collection.

limitinteger

The maximum number of documents to return. This field is by default 1024, and cannot be set larger than 1024

path_prefixstring nullable

All documents returned will have a path that starts with the provided path prefix.

path_gtstring nullable

All documents returned will have a path strictly greater than the provided path_gt argument. (Comparison will be based on lexicographic comparison. It is guaranteed that two strings are lexicographically equal if and only if they have identical binary representations.).

Response

Successful Response

Changes