---
title: "Find Documents"
method: GET
path: "/api/v1/documents/"
tags: ["Document"]
---

# Find Documents

`GET /api/v1/documents/`

## Request

- Base URL: `https://api.gemina.co` (the document declares no server; this is the origin it was published from)
- URL: `https://api.gemina.co/api/v1/documents/`
- Auth: API key in header `X-API-Key`

Return a list of users, based on given parameters.

## Query parameters

- `skip` integer: Number of items to skip
- `limit` integer: Number of items to retrieve
- `search_query` string, nullable: Filter for a given search query
- `sort_field` string, nullable: Field to sort by
- `sort_method` 'asc' | 'desc'
- `external_id` string, nullable: Filter for a given external identifier
- `end_user_id` string, nullable: Filter for an End User ID
- `with_purged` boolean, nullable: Include purged documents

## Response `200`

Successful Response

- DocumentsViewOutDTO
  - `servedAt` string, date-time
  - `servedAtTimestamp` number
  - `createdAt` string, date-time, nullable
  - `createdAtTimestamp` number, nullable
  - `status` 'pending' | 'in_process' | 'failed' | 'success' | 'partial' | 'empty', required
  - `meta` ViewMetaOutDTO, required
    - `count` integer, required
    - `skip` integer, required
    - `limit` integer, required
    - `sortField` string, nullable
    - `sortMethod` 'asc' | 'desc', required
    - `filters` object, required
  - `data` DocumentViewDataOutDTO, required
    - `documents` DocumentViewOutDTO[], nullable, required
      - `status` 'pending' | 'in_process' | 'failed' | 'success' | 'partial' | 'empty', required
      - `meta` DocumentViewMetaOutDTO, required
        - `externalId` string, nullable
        - `documentId` string, uuid, nullable
        - `userId` string, uuid, nullable
        - `endUserId` string, nullable
        - `apiKeyId` string, uuid, nullable
        - `filename` string, nullable
        - `fileSize` integer, nullable
        - `contentType` string, nullable
        - `documentFileType` 'pdf' | 'image' | 'other'
        - `numberOfPages` integer, nullable
        - `normalizedWidth` integer, nullable
        - `normalizedHeight` integer, nullable
        - `normalizedMegapixels` number, nullable
        - `storageLocation` 'israel' | 'europe' | 'united_states' | 'asia'
        - `imageUrl` string, uri, nullable
        - `thumbnailUrl` string, uri, nullable
        - `originalDocumentUrl` string, uri, nullable
        - `processingStatus` 'pending' | 'in_process' | 'failed' | 'success' | 'partial' | 'empty'
        - `createdAt` string, date-time, required
        - `contentPurgedAt` string, date-time, nullable, required
      - `data` DocumentDataOutDTO, required
        - `extractions` ExtractionProcessingResultOutDTO[], nullable
          - `status` 'pending' | 'in_process' | 'failed' | 'success' | 'partial' | 'empty', required
          - `meta` ExtractionMetaOutDTO, required
            - `extractionId` string, uuid, nullable
            - `modelType` 'gemina' | 'google' | 'openai' | 'velox' | 'praetorian' | 'invictus', required
            - `thinking` boolean, required
            - `correction` boolean, required
            - `evaluation` boolean, required
            - `includeCoordinates` boolean, required
            - `processorClass` string, required
            - `extractionType` 'ocr' | 'document_details_hebrew' | 'document_line_items_hebrew' | 'invoice_headers' | 'invoice_line_items' | 'custom_template' | 'filetag', required: Defines the type of operation to perform on the uploaded document
            - `latencySeconds` number, nullable
            - `numberOfFields` integer, nullable
            - `purgeAt` string, date-time, nullable, required
            - `purgedAt` string, date-time, nullable, required
            - `purgeReason` 'user_deleted' | 'retention_expired' | 'admin_action', required
            - `validationFeedback` ValidationSchemaModel
              - …
            - `validated` boolean
          - `values` object, nullable, required
          - `verifiedValues` object, nullable
          - `verifiedDiff` VerifiedDiffEntryOutDTO[], nullable
            - `field` string, required
            - `status` 'corrected' | 'added' | 'removed', required
            - `pointer` string, nullable
            - `original` union
              - …
            - `verified` union
              - …
          - `errors` object[]
      - `errors` object[]
  - `errors` object[]

## Other responses

- `400`: Malformed request — for example an unknown sort field.
- `422`: Validation Error

---

[API](https://skmtc.dev/gemina/apis/gemina-api.md) · [All operations](https://skmtc.dev/gemina/apis/gemina-api/llms.txt) · [OpenAPI document](https://skmtc.dev/gemina/apis/gemina-api/revisions/152fd3f6f6ec?raw)