Skip to main content
POST
List files within a collection

Authorizations

Authorization
string
header
required

JWT token passed in authorization header

Path Parameters

id
string
required

Body

application/json
lean
boolean
compact
boolean
page
integer
pageSize
integer
status
enum<string>

Filter the collection's files by status. Mirrors the shape used by /api/user/uploads:

  • Real DB values (inactive/selected/active/error/deleted) match exactly.
  • Pseudo-value excluded expands to status $nin:['selected','deleted'].
  • Pseudo-value processing matches files currently mid-ingestion (ingestion.phase ∈ {extract, chunk, sanitize, embed, kag} AND status $ne:'deleted'). When omitted, defaults to $ne:'deleted'.
Available options:
inactive,
selected,
active,
error,
deleted,
excluded,
processing
nameOrder
boolean
sortAscending
boolean
sortBy
string

Response

200 - application/json

Paginated list of files in the collection, plus child sub-collections

success
boolean
data
object[]

Array of UploadFile objects. In lean/compact mode, each file is enriched with owner_data (for instance/account files), institution_name, and institution_display_name (for account_shared files).

childCollections
object[]

Direct child sub-collections with stats

total
integer
hasMore
boolean
page
integer
pageSize
integer