> ## Documentation Index
> Fetch the complete documentation index at: https://docs.linqalpha.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Document Sync Status

> Returns per-document sync status. At least one filter (path, name, or document_ids) is required.



## OpenAPI

````yaml GET /v1/status/documents
openapi: 3.0.1
info:
  title: LinqAlpha API
  description: >-
    Linq helps finance professionals make informed decisions using
    Retrieval-Augmented Generation (RAG)-enhanced answers. By leveraging
    cutting-edge Large Language Models (LLM) and supplementary technology, Linq
    provides the most optimized responses based on your queries.
  version: 1.0.0
  license:
    name: MIT
servers:
  - url: https://api.linqalpha.com
security:
  - ApiKeyAuth: []
tags:
  - name: Search
    description: Search and generate responses
  - name: Data
    description: Data retrieval and mapping
  - name: Feedback
    description: Conversation feedback
  - name: RMS
    description: Research Management System
  - name: Source Management
    description: Source batch and file management
  - name: MCP
    description: >-
      LinqAlpha MCP — Financial data tools for AI assistants via Model Context
      Protocol
  - name: Connectors
    description: Customer Connectors — customer-owned MCP connector management
  - name: Briefing
    description: Briefing Agent — automated market briefings with scheduling and delivery
  - name: Status
    description: Sync status — check organization, document, and container sync progress
paths:
  /v1/status/documents:
    get:
      tags:
        - Status
      summary: Document sync status
      description: >-
        Returns per-document sync status. At least one filter (path, name, or
        document_ids) is required.
      parameters:
        - name: organization_id
          in: query
          description: Organization ID. Optional for single-org API keys.
          required: false
          schema:
            type: string
        - name: document_ids
          in: query
          description: Comma-separated document IDs.
          required: false
          schema:
            type: string
          example: doc-id-1,doc-id-2
        - name: path
          in: query
          description: Filter by path prefix.
          required: false
          schema:
            type: string
        - name: name
          in: query
          description: Filter by document name (partial, case-insensitive).
          required: false
          schema:
            type: string
      responses:
        '200':
          description: Document status list
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    nullable: true
                  payload:
                    type: array
                    items:
                      type: object
                      properties:
                        document_id:
                          type: string
                        document_name:
                          type: string
                        status:
                          type: string
                          description: >-
                            Display status: Synced, Syncing, Syncing Failed,
                            Deleting, Deleting Failed
                        extraction_status:
                          type: string
                          enum:
                            - pending
                            - completed
                            - failed
                        last_synced_at:
                          type: string
                          nullable: true
                        summary:
                          type: string
                          nullable: true
                          description: LLM-generated document summary
              example:
                error: null
                payload:
                  - document_id: 40aef76a-bb93-4f3c-9f4f-9119f38d85bf
                    document_name: Q1 Earnings Report.pdf
                    status: Synced
                    extraction_status: completed
                    last_synced_at: '2026-04-08T02:38:15'
                    summary: Q1 2026 earnings report showing 15% YoY revenue growth...
                  - document_id: 7fe4d59f-1097-466d-a7fe-a60e8fe58c46
                    document_name: Old Report.pdf
                    status: Syncing Failed
                    extraction_status: pending
                    last_synced_at: null
                    summary: null
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-KEY

````