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

const client = new Morphik({
  apiKey: 'My API Key',
});

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

console.log(folder.id);
{
  "id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "document_ids": [
    "<string>"
  ],
  "system_metadata": {},
  "rules": [
    {}
  ],
  "workflow_ids": [
    "<string>"
  ],
  "app_id": "<string>",
  "end_user_id": "<string>"
}

Headers

authorization
string

Path Parameters

folder_id
string
required

Response

Successful Response

Represents a folder that contains documents

name
string
required
id
string
description
string | null
document_ids
string[] | null
system_metadata
object
rules
Rules · object[]
workflow_ids
string[]

List of workflow IDs to run on document ingestion

app_id
string | null
end_user_id
string | null
I