List Folder Summaries

Return compact folder list (id, name, doc_count, updated_at).

GET /folders/summary

JavaScript

JavaScript

import Morphik from 'morphik';

const client = new Morphik({
  apiKey: process.env['MORPHIK_API_KEY'], // This is the default and can be omitted
});

const folderSummaries = await client.folders.listSummaries();

console.log(folderSummaries);

200

[
  {
    "id": "<string>",
    "name": "<string>",
    "full_path": "<string>",
    "depth": 123,
    "description": "<string>",
    "doc_count": 0,
    "updated_at": "<string>"
  }
]

Headers

authorization · string | null

Response

200

application/json

Successful Response

id · string · required

name · string · required

full_path · string | null

depth · integer | null

description · string | null

doc_count · integer · default: 0

updated_at · string | null