---
title: "Get Document Info List"
method: POST
path: "/documents/get-document-info-list"
tags: ["Documents"]
---

# Get Document Info List

`POST /documents/get-document-info-list`

Retrives a list of document metadata information that matches the provided filters.

The documents returned will be sorted by path in lexicographically ascending order. `path_gt` can be used for pagination, and should be set to the path of the last document returned in the previous call.

A `404 Not Found` will be returned if either the collection name does not exist, or the document path does not exist within the provided collection.

## Request body

- GetDocumentInfoListRequest
  - `collection_name` string, required — The name of the collection.
  - `limit` integer — The maximum number of documents to return. This field is by default 1024, and cannot be set larger than 1024
  - `path_prefix` string, nullable — All documents returned will have a path that starts with the provided path prefix.
  - `path_gt` string, nullable — All documents returned will have a path strictly greater than the provided `path_gt` argument. (Comparison will be based on lexicographic comparison. It is guaranteed that two strings are lexicographically equal if and only if they have identical binary representations.).

## Response `200`

Successful Response

- GetDocumentInfoListResponse
  - `documents` DocumentMetadataResponse[], required
    - `id` string, uuid, required
    - `collection_name` string, required
    - `path` string, required
    - `metadata` DocumentMetadataJson, required
    - `index_status` 'not_parsed' | 'parsing' | 'not_indexed' | 'indexing' | 'indexed' | 'parsing_failed' | 'indexing_failed', required
    - `created_at` string, date-time, required
    - `size` integer, required — The total size of the raw document data, in bytes.
    - `num_pages` integer, nullable, required — The number of pages in this document. This will be `null` if the document is parsing or failed to parse. It can also be `null` if the document is a filetype that does not support pages.
    - `file_url` string, required — A URL to the document data, which can be used to download the raw document content or to display the document in frontend applications. NOTE: If a `/documents/update-document` call returned a new document id, then this url will be invalidated and must be retrieved again.

## Other responses

- `400` — Bad Request
- `404` — Not Found
- `422` — Validation Error

## Changes

- **2025-06-03** `6d4d2509d6d6` — 1 warning, 5 info
  - removed the request property `id_gt`
  - added the new optional request property `path_gt`
  - added the new optional request property `path_prefix`
  - added the required property `documents/items/created_at` to the response with the `200` status
  - …2 more
- **2025-01-27** `99a41bb73e43` — 2 warning
  - added the new `indexing_failed` enum value to the `documents/items/index_status` response property for the response status `200`
  - added the new `parsing` enum value to the `documents/items/index_status` response property for the response status `200`

[Change history](https://skmtc.dev/zeroentropy-ai/apis/zeroentropy-api/changes/documents/get-document-info-list/post.md)

---

[API](https://skmtc.dev/zeroentropy-ai/apis/zeroentropy-api.md) · [All operations](https://skmtc.dev/zeroentropy-ai/apis/zeroentropy-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/zeroentropy-ai/zeroentropy-api/revisions/5ff1b24060b9/schema)