List Docs

Flexible document listing with aggregates, projections, and advanced pagination.

Supported operators: $and, $or, $nor, $not, $eq, $ne, $gt, $gte, $lt, $lte, $in, $nin, $exists, $type, $regex, $contains.

Implicit equality (backwards compatible, JSONB containment):

{"status": "active"}

Explicit operators (typed comparisons for number, decimal, datetime, date):

{"priority": {"$gte": 40}, "end_date": {"$lt": "2025-01-01"}}

Use folder_name and end_user_id query parameters to scope system metadata.

POST /documents/list_docs

Try it

JavaScript

JavaScript

import Morphik from 'morphik';

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

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

console.log(response.limit);

200

{
  "skip": 123,
  "limit": 123,
  "returned_count": 123,
  "documents": [
    "<unknown>"
  ],
  "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 · 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

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). Derived fields such as 'page_count' are also supported.

Response

200

application/json

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 · Status Counts · object

Show child attributes

status_counts. {key} · integer

folder_counts · FolderCount · object[] | null

Show child attributes

folder_counts. folder · string | null · required

folder_counts. count · integer · required