Sign in
Documents

List Docs

Flexible document listing endpoint with support for aggregates, projections, and advanced pagination.

request.document_filters supports equality plus $and, $or, $nor, $not, $in, $nin, $exists, $regex, and $contains, with arbitrary nesting. Scalar comparisons match array elements automatically. Example:

{
  "$and": [
    {"category": "patent"},
    {"$nor": [{"status": "archived"}, {"priority": {"$in": ["low", "medium"]}}]}
  ]
}

Use the folder_name and end_user_id query parameters to scope system metadata instead of embedding those keys in the filter payload.

post/documents/list_docs

Query parameters

string
OR
string[]
end_user_idstring nullable

Headers

authorizationstring

Request body

document_filtersobject nullable

Metadata filters for documents

skipinteger

Number of documents to skip

limitinteger

Maximum number of documents to return

return_documentsboolean

When false, only aggregates are returned

include_total_countboolean

Include total number of matching documents when true

include_status_countsboolean

Include document counts grouped by processing status when true

include_folder_countsboolean

Include document counts grouped by folder when true

completed_onlyboolean

When true, only documents with completed processing status are returned and counted

sort_by'created_at' | 'updated_at' | 'filename' | 'external_id' nullable

Field to sort the results by

sort_direction'asc' | 'desc'

Sort direction for the results

fieldsstring[] nullable

Optional list of fields to project for each document (dot notation supported)

Response

Successful Response

skipinteger required
limitinteger required
returned_countinteger required
total_countinteger nullable
has_moreboolean
next_skipinteger nullable
status_countsobject nullable

Changes