> ## Documentation Index > Fetch the complete documentation index at: https://docs.docintell.com/llms.txt > Use this file to discover all available pages before exploring further. # List all documents > List all documents in your account. Returns a paginated list of documents with their latest extraction job status. Returns: DocumentListResponse with paginated document list. ## OpenAPI ````yaml openapi.json get /v1/documents openapi: 3.1.0 info: title: DocIntell API description: >- # DocIntell API **Turn Documents into Data. Keep the Source Safe.** Financial document intelligence platform that turns PDFs into queryable data while keeping source files secure and compliant. ## Features - **Document Ingestion**: Upload PDFs with SEC 17a-4 compliant immutable storage - **Schema Projection**: Query extracted data with custom schemas (not data dumps!) - **Multi-Schema Support**: Same document, multiple query patterns - **Webhook Delivery**: Async notifications on job completion - **Row-Level Security**: Multi-tenant isolation built-in ## Authentication All API endpoints (except `/health`, `/`, `/docs`, and `/redoc`) require API key authentication. Include your API key in the `Authorization` header: ``` Authorization: Bearer dk_live_ ``` Test keys start with `dk_test_`, production keys with `dk_live_`. ## Rate Limiting Per-tenant rate limits: - **Document ingestion**: 100 documents/hour - **Projection queries**: 1,000 requests/hour - **Schema operations**: 10 creates/hour Rate limit info is returned in response headers: - `X-RateLimit-Limit`: Maximum requests allowed - `X-RateLimit-Remaining`: Remaining requests in window - `X-RateLimit-Reset`: Unix timestamp when limit resets ## Error Handling All errors follow RFC 7807 Problem Details format: ```json { "error": "error_code", "message": "Human-readable description", "details": {} } ``` Common error codes: - `unauthorized` (401): Missing or invalid API key - `rate_limit_exceeded` (429): Too many requests - `invalid_file_type` (400): Only PDFs supported - `file_too_large` (413): File exceeds size limit (default 100MB, configurable via MAX_UPLOAD_SIZE_MB) - `job_not_found` (404): Job ID doesn't exist or doesn't belong to tenant ## Getting Started 1. Obtain API key from dashboard 2. Upload PDF: `POST /v1/documents` 3. Poll status: `GET /v1/documents/{document_id}/status` 4. Query results: `POST /v1/documents/{document_id}/project` Full documentation: [https://docs.docintel.com](https://docs.docintel.com) contact: name: DocIntell Support url: https://docintel.com/support email: support@docintel.com license: name: Proprietary url: https://docintel.com/terms version: 0.1.0 servers: - url: http://localhost:8000 description: Local development - url: https://api.docintell.com description: Production API - url: https://api-staging.docintell.com description: Staging environment security: - bearerAuth: [] tags: - name: health description: Health check operations. Verify service and dependency connectivity. x-mint-tag-group: System - name: api_keys description: API key management operations. Create, list, and revoke API keys. x-mint-tag-group: Management - name: documents description: Document ingestion operations. Upload PDFs for extraction. x-mint-tag-group: Core - name: jobs description: >- Job status and query operations. Check extraction status and query results. x-mint-tag-group: Core - name: document-types description: >- Document type schemas. List and retrieve extraction schema definitions for financial document types. - name: webhooks description: >- Webhook configuration management. Create, update, and manage webhook endpoints for job completion notifications. x-mint-tag-group: Integrations - name: stats description: Analytics and metrics endpoints. Get document, job, and schema statistics. - name: views description: >- View management for consumption layer. Define field subsets for querying extraction data. paths: /v1/documents: get: tags: - documents summary: List all documents description: >- List all documents in your account. Returns a paginated list of documents with their latest extraction job status. Returns: DocumentListResponse with paginated document list. operationId: list_documents_v1_documents_get parameters: - name: page in: query required: false schema: type: integer minimum: 1 description: Page number (1-indexed) default: 1 title: Page description: Page number (1-indexed) - name: per_page in: query required: false schema: type: integer maximum: 100 minimum: 1 description: Items per page (max 100) default: 20 title: Per Page description: Items per page (max 100) responses: '200': description: Paginated list of documents content: application/json: schema: $ref: '#/components/schemas/DocumentListResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' components: schemas: DocumentListResponse: properties: documents: items: $ref: '#/components/schemas/DocumentListItem' type: array title: Documents description: List of documents total: type: integer title: Total description: Total number of documents matching the query page: type: integer title: Page description: Current page number (1-indexed) per_page: type: integer title: Per Page description: Number of items per page type: object required: - documents - total - page - per_page title: DocumentListResponse description: Response for listing documents (GET /v1/documents). examples: - documents: - created_at: '2025-11-27T10:30:00Z' document_id: 6789def0-abcd-4567-ef01-23456789abcd file_size_bytes: 1234567 latest_job_status: completed page_count: 12 vault_uri: gs://docintel-vault-prod/tenant-123/2025/550e8400.pdf page: 1 per_page: 20 total: 100 HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError DocumentListItem: properties: document_id: type: string format: uuid title: Document Id description: Unique identifier for the document vault_uri: type: string title: Vault Uri description: GCS path to the document in Cold Vault file_size_bytes: anyOf: - type: integer - type: 'null' title: File Size Bytes description: Document file size in bytes page_count: anyOf: - type: integer - type: 'null' title: Page Count description: Number of pages in the document created_at: type: string format: date-time title: Created At description: Document creation timestamp (ISO 8601) latest_job_status: anyOf: - type: string enum: - pending - processing - completed - failed - type: 'null' title: Latest Job Status description: Status of the most recent extraction job type: object required: - document_id - vault_uri - created_at title: DocumentListItem description: Item in document list response. examples: - created_at: '2025-11-27T10:30:00Z' document_id: 6789def0-abcd-4567-ef01-23456789abcd file_size_bytes: 1234567 latest_job_status: completed page_count: 12 vault_uri: gs://docintel-vault-prod/tenant-123/2025/550e8400.pdf ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type type: object required: - loc - msg - type title: ValidationError securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: API Key description: 'API Key authentication. Format: dk_test_ or dk_live_' ````