Skip to main content
POST
/
documents
JavaScript
import Morphik from 'morphik';

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

const documents = await client.documents.list();

console.log(documents);
[
  {
    "content_type": "<string>",
    "external_id": "<string>",
    "filename": "<string>",
    "metadata": {},
    "metadata_types": {},
    "storage_info": {},
    "storage_files": [
      {
        "bucket": "<string>",
        "key": "<string>",
        "version": 1,
        "filename": "<string>",
        "content_type": "<string>",
        "timestamp": "2023-11-07T05:31:56Z"
      }
    ],
    "system_metadata": {},
    "additional_metadata": {},
    "chunk_ids": [
      "<string>"
    ],
    "folder_name": "<string>",
    "end_user_id": "<string>",
    "app_id": "<string>",
    "folder_path": "<string>"
  }
]

Headers

​
authorization
string

Query Parameters

​
folder_name
​
folder_depth
integer | null

Folder scope depth: 0/None = exact, -1 = all descendants, n > 0 = include descendants up to n levels.

​
end_user_id
string | null

Body

application/json

Request model for listing documents

​
document_filters
Document Filters · object

Metadata filters with operator support: $and, $or, $nor, $not, $eq, $ne, $gt, $gte, $lt, $lte, $in, $nin, $exists, $type, $regex, $contains. Implicit equality uses JSONB containment; explicit operators support typed comparisons.

​
skip
integer
default:0

Number of documents to skip before returning results.

Required range: x >= 0
​
limit
integer
default:1000

Maximum number of documents to return.

Response

Successful Response

​
content_type
string
required
​
external_id
string
​
filename
string | null
​
metadata
Metadata · object
​
metadata_types
Metadata Types · object
​
storage_info
Storage Info · object
​
storage_files
StorageFileInfo · object[]
​
system_metadata
System Metadata · object
​
additional_metadata
Additional Metadata · object
​
chunk_ids
string[]
​
folder_name
string | null
​
end_user_id
string | null
​
app_id
string | null
​
folder_path
string | null