JavaScript

import Morphik from 'morphik';

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

const response = await client.documents.listDocs();

console.log(response.limit);

{
  "documents": [
    "<any>"
  ],
  "skip": 123,
  "limit": 123,
  "returned_count": 123,
  "total_count": 123,
  "has_more": false,
  "next_skip": 123,
  "status_counts": {},
  "folder_counts": [
    {
      "folder": "<string>",
      "count": 123
    }
  ]
}

Documents

List Docs

Flexible document listing endpoint with support for aggregates, projections, and advanced pagination.

request.document_filters supports equality plus $and, $or, $nor, $not, $in, $nin, $exists, $regex, and $contains, with arbitrary nesting. Scalar comparisons match array elements automatically. Example:

{
  "$and": [
    {"category": "patent"},
    {"$nor": [{"status": "archived"}, {"priority": {"$in": ["low", "medium"]}}]}
  ]
}

Use the folder_name and end_user_id query parameters to scope system metadata instead of embedding those keys in the filter payload.

POST

documents

list_docs

JavaScript

import Morphik from 'morphik';

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

const response = await client.documents.listDocs();

console.log(response.limit);

{
  "documents": [
    "<any>"
  ],
  "skip": 123,
  "limit": 123,
  "returned_count": 123,
  "total_count": 123,
  "has_more": false,
  "next_skip": 123,
  "status_counts": {},
  "folder_counts": [
    {
      "folder": "<string>",
      "count": 123
    }
  ]
}

Headers

authorization

string

Query Parameters

folder_name

end_user_id

string | null

Body

application/json

Flexible request model for listing documents with projection and aggregates.

document_filters

object | null

Metadata filters for documents

skip

integer

default:0

Number of documents to skip

Required range: x >= 0

limit

integer

default:100

Maximum number of documents to return

Required range: x >= 0

return_documents

boolean

default:true

When false, only aggregates are returned

include_total_count

boolean

default:false

Include total number of matching documents when true

include_status_counts

boolean

default:false

Include document counts grouped by processing status when true

include_folder_counts

boolean

default:false

Include document counts grouped by folder when true

completed_only

boolean

default:false

When true, only documents with completed processing status are returned and counted

sort_by

enum<string> | null

default:updated_at

Field to sort the results by

Available options:

created_at,

updated_at,

filename,

external_id

sort_direction

enum<string>

default:desc

Sort direction for the results

Available options:

asc,

desc

fields

string[] | null

Optional list of fields to project for each document (dot notation supported)

Response

Successful Response

Flexible response for listing documents with aggregates.

skip

integer

required

limit

integer

required

returned_count

integer

required

documents

any[]

total_count

integer | null

has_more

boolean

default:false

next_skip

integer | null

status_counts

object | null

Show child attributes

folder_counts

FolderCount · object[] | null

Show child attributes

List Documents Get Document

⌘I

Getting Started

API Reference

models

health

Ingestion

Documents

Folders

document

model-config

Logs

Cache

Graph

Enterprise

EE - Connectors

List Docs

Headers

Query Parameters

Body

Response