Skip to main content
GET
/
folders
/
{folder_id_or_name}
JavaScript
import Morphik from 'morphik';

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

const folder = await client.folders.retrieve('folder_id_or_name');

console.log(folder.id);
{
  "name": "<string>",
  "id": "<string>",
  "full_path": "<string>",
  "parent_id": "<string>",
  "depth": 123,
  "description": "<string>",
  "document_ids": [
    "<string>"
  ],
  "system_metadata": {},
  "summary_storage_key": "<string>",
  "summary_version": 123,
  "summary_bucket": "<string>",
  "summary_updated_at": "<string>",
  "app_id": "<string>",
  "end_user_id": "<string>",
  "child_count": 123
}

Headers

authorization
string

Path Parameters

folder_id_or_name
string
required

Response

Successful Response

Represents a folder that contains documents

name
string
required
id
string
full_path
string | null
parent_id
string | null
depth
integer | null
description
string | null
document_ids
string[] | null
system_metadata
System Metadata · object
summary_storage_key
string | null
summary_version
integer | null
summary_bucket
string | null
summary_updated_at
string | null
app_id
string | null
end_user_id
string | null
child_count
integer | null