Folders

Retrieve folder metadata with optional document statistics and projections.

post/folders/details

Request

  • Base URL
    https://api.morphik.ai (the document declares no server; this is the origin it was published from)
  • URL
    https://api.morphik.ai/folders/details
  • Auth
    none declared

Headers

authorizationstring nullable

Request body

identifiersstring[] nullable

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

include_document_countboolean

Include total document count when true

include_status_countsboolean

Include document counts grouped by status when true

include_documentsboolean

Include a paginated list of documents for each folder when true

document_filtersobject nullable

Optional metadata filters applied when computing folder document statistics

document_skipinteger

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

document_limitinteger

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

document_fieldsstring[] nullable

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

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

Field to sort folder documents by when include_documents is true

sort_direction'asc' | 'desc'

Sort direction for folder documents when include_documents is true

Response

Successful Response

Changes

    • info

      header request parameter authorization list-of-types was widened by adding types null

    • info

      for the header request parameter authorization, the type was generalized from string to no type

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status