> ## 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 extraction jobs > List extraction jobs in your account. Returns a paginated list of extraction jobs with optional filtering by status or document. Jobs are ordered by created_at descending (newest first). Args: session_and_auth: Database session and auth context (injected). status: Optional filter by job status (pending, processing, completed, failed). document_id: Optional filter by specific document UUID. page: Page number (1-indexed). Values < 1 are normalized to 1. per_page: Items per page (1-100). Values outside range are clamped. Returns: JobListResponse: Paginated list with total count and job items. Edge Cases: - **Empty results**: Returns empty list with total=0, not 404. - **Invalid page**: Page numbers < 1 are normalized to 1. - **Exceeds total**: Requesting page beyond total returns empty items list. - **Combined filters**: status AND document_id filters are ANDed together. - **Tenant isolation**: Only jobs belonging to the authenticated tenant are returned. ## OpenAPI ````yaml openapi.json get /v1/jobs 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/jobs: get: tags: - jobs summary: List extraction jobs description: >- List extraction jobs in your account. Returns a paginated list of extraction jobs with optional filtering by status or document. Jobs are ordered by created_at descending (newest first). Args: session_and_auth: Database session and auth context (injected). status: Optional filter by job status (pending, processing, completed, failed). document_id: Optional filter by specific document UUID. page: Page number (1-indexed). Values < 1 are normalized to 1. per_page: Items per page (1-100). Values outside range are clamped. Returns: JobListResponse: Paginated list with total count and job items. Edge Cases: - **Empty results**: Returns empty list with total=0, not 404. - **Invalid page**: Page numbers < 1 are normalized to 1. - **Exceeds total**: Requesting page beyond total returns empty items list. - **Combined filters**: status AND document_id filters are ANDed together. - **Tenant isolation**: Only jobs belonging to the authenticated tenant are returned. operationId: list_jobs_v1_jobs_get parameters: - name: status in: query required: false schema: anyOf: - type: string enum: - pending - processing - completed - failed - type: 'null' description: Filter by job status title: Status description: Filter by job status - name: document_id in: query required: false schema: anyOf: - type: string format: uuid - type: 'null' description: Filter by document ID title: Document Id description: Filter by document ID - 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 extraction jobs content: application/json: schema: $ref: '#/components/schemas/JobListResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' components: schemas: JobListResponse: properties: jobs: items: $ref: '#/components/schemas/JobListItem' type: array title: Jobs description: List of extraction jobs total: type: integer title: Total description: Total number of jobs 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: - jobs - total - page - per_page title: JobListResponse description: Response for listing jobs (GET /v1/jobs). examples: - jobs: - created_at: '2025-11-27T10:30:00Z' document_id: 6789def0-abcd-4567-ef01-23456789abcd job_id: 550e8400-e29b-41d4-a716-446655440000 processing_completed_at: '2025-11-27T10:30:45Z' processing_time_seconds: 45.2 status: completed page: 1 per_page: 20 total: 50 HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError JobListItem: properties: job_id: type: string format: uuid title: Job Id description: Unique identifier for the extraction job document_id: type: string format: uuid title: Document Id description: Document this job belongs to status: type: string enum: - pending - processing - completed - failed title: Status description: Current job status created_at: type: string format: date-time title: Created At description: Job creation timestamp (ISO 8601) processing_completed_at: anyOf: - type: string format: date-time - type: 'null' title: Processing Completed At description: When extraction completed (ISO 8601) processing_time_seconds: anyOf: - type: number - type: 'null' title: Processing Time Seconds description: Total processing duration in seconds type: object required: - job_id - document_id - status - created_at title: JobListItem description: Item in job list response. examples: - created_at: '2025-11-27T10:30:00Z' document_id: 6789def0-abcd-4567-ef01-23456789abcd job_id: 550e8400-e29b-41d4-a716-446655440000 processing_completed_at: '2025-11-27T10:30:45Z' processing_time_seconds: 45.2 status: completed 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_' ````