Skip to main content
POST
JavaScript

Headers

authorization
string | null

Body

application/json

Request model for retrieving folder details with document statistics.

identifiers
string[] | null

List of folder IDs or names. If omitted, returns details for all accessible folders.

include_document_count
boolean
default:true

Include total document count when true

include_status_counts
boolean
default:false

Include document counts grouped by status when true

include_documents
boolean
default:false

Include a paginated list of documents for each folder when true

document_filters
Document Filters · object | null

Optional metadata filters applied when computing folder document statistics

document_skip
integer
default:0

Number of documents to skip within each folder when include_documents is true

Required range: x >= 0
document_limit
integer
default:25

Maximum number of documents to return per folder when include_documents is true

Required range: x >= 0
document_fields
string[] | null

Optional list of fields to project for folder documents (dot notation supported)

sort_by
enum<string> | null
default:updated_at

Field to sort folder documents by when include_documents is true

Available options:
created_at,
updated_at,
filename,
external_id
sort_direction
enum<string>
default:desc

Sort direction for folder documents when include_documents is true

Available options:
asc,
desc

Response

Successful Response

Response wrapping folder detail entries.

folders
FolderDetails · object[]
required