v1

latestOpenAPI 3.0.02026-07-263365159.1 KB

Documents

List All Documents

Fetch a comprehensive list of all documents in your account. You can filter and sort the results using various parameters, such as document type, status, creation date, and folder.

get/api/v1/eevee/apikey/documents/all/

Query parameters

view'files' | 'folder' | 'all_files'

Specify how to filter the documents.

folder: List only documents within the specified folder_id.
files: List only documents that are not in any folder.
all_files: List all documents, including those inside folders.

folder_idstring

The ID of the folder to filter by. This parameter is required when view is set to folder.

limitinteger

The maximum number of documents to return in the response (up to 20).

offsetinteger

The number of documents to skip for pagination.

doc_typestring

Filter by a specific document type. You can get the available doc_type values from the 'Get User Details and Document Types' endpoint.

status'reviewing' | 'processed' | 'erred'

Filter documents by their processing status.

qstring

Search for a keyword or phrase in document titles. This performs a partial match.

sort_by'created_date.asc' | 'created_date.desc'

Sort the documents by their creation date.

created_datestring

Filter documents by creation date range. Use the format [operator]:[YYYY-MM-DD].

gte:YYYY-MM-DD: Greater than or equal to a specific date.
lte:YYYY-MM-DD: Less than or equal to a specific date.

You can combine both for a date range (e.g., gte:2025-03-20&lte:2025-03-30).

Headers

apikeystring required

Your personal API key for authentication. You can find it on your Docsumo settings page.

Response

errorstring

A message describing any errors encountered during the request.

error_codestring

A code representing the specific error, if any.

messagestring

Additional information or context about the response.

statusstring

The status of the request (e.g., 'success' or 'fail').

status_codeinteger

The HTTP status code of the response.