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

# List documents (chat id)

> Chat-centric document list. Id is a Deep Reader chat pk.

Older **chat-centric** list. `{id}` on sibling routes is a Deep Reader **chat** primary key, not an attachment id. Prefer [List documents](/api-reference/documents/list-attachments) for new integrations.


## OpenAPI

````yaml GET /api/v2/documents/
openapi: 3.1.0
info:
  title: Abacus Docs API
  version: 1.0.0
  description: |
    REST + SSE surface for Abacus Docs on the same host as the web app
    (`https://abacusdocs.com`). Paths are `/api/v2/…`.

    Authenticate with an organisation API key (`sk-abacus-*`) as a Bearer
    token, or an Auth0 access token. Cross-tenant reads return **404**, not
    403. Page-based lists use `?page=` and `?page_size=`.

    Extraction, reprocess, schema tests, and chat turns spend credits.
    See the help centre Credits pages for rates.
  contact:
    name: Abacus Docs
    url: https://abacusdocs.com/contact
servers:
  - url: https://abacusdocs.com
    description: Production (Extract)
security: []
paths:
  /api/v2/documents/:
    get:
      tags:
        - v2/documents
      summary: List documents
      description: >-
        Paginated, recency-first list of the authenticated user's documents.
        Supports optional title search and status filtering.
      operationId: v2_documents_list
      parameters:
        - in: query
          name: cursor
          schema:
            type: string
          description: Opaque cursor for next-page navigation.
        - name: page_size
          required: false
          in: query
          description: Number of results to return per page.
          schema:
            type: integer
        - in: query
          name: q
          schema:
            type: string
          description: Full-text document content search via Lynx BM25. Minimum 2 chars.
        - in: query
          name: status
          schema:
            type: string
            enum:
              - all
              - completed
              - failed
              - pending
          description: Filter by processing status.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedDocumentListItemList'
          description: ''
      security:
        - extractApiKey: []
        - bearerAuth: []
        - cookieAuth: []
components:
  schemas:
    PaginatedDocumentListItemList:
      type: object
      required:
        - results
      properties:
        next:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?cursor=cD00ODY%3D"
        previous:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?cursor=cj0xJnA9NDg3
        results:
          type: array
          items:
            $ref: '#/components/schemas/DocumentListItem'
    DocumentListItem:
      type: object
      description: >-
        Minimal document projection for library grid cards.


        Combines Chat fields (id, title, created_at) with ChatAttachment
        processing

        state. Views must call prefetch_related('attachments') to avoid N+1
        queries.


        When the view performs a Lynx BM25 search, it passes ``snippets`` and

        ``scores`` dicts (keyed by Chat pk) via serializer context so each item

        gets the matching excerpt and relevance score.
      properties:
        id:
          type: integer
          readOnly: true
        title:
          type: string
          maxLength: 255
        created_at:
          type: string
          format: date-time
          readOnly: true
        status:
          type: string
          readOnly: true
        progress:
          type: integer
          readOnly: true
        stage:
          type: string
          readOnly: true
        page_count:
          type: integer
          readOnly: true
        file_type:
          type: string
          readOnly: true
        file_name:
          type: string
          readOnly: true
        completed_at:
          type:
            - string
            - 'null'
          readOnly: true
        summary:
          type:
            - string
            - 'null'
          readOnly: true
        has_extraction:
          type: boolean
          readOnly: true
        has_translation:
          type: boolean
          readOnly: true
        has_overrides:
          type: boolean
          description: >-
            True iff the doc has any user-edited cells (AD-164 editable batch
            grid).


            Surfaces an "edited" badge in the SPA list view so users can spot
            which

            docs have human corrections without opening the detail page.
          readOnly: true
        has_warnings:
          type: boolean
          description: >-
            True iff the doc has any per-page processing warnings from Lynx
            (AD-147).


            Surfaces a warning icon in the SPA list view; SPA can navigate to
            the

            viewer to see per-page detail.
          readOnly: true
        snippet:
          type:
            - string
            - 'null'
          readOnly: true
        score:
          type:
            - number
            - 'null'
          format: double
          readOnly: true
      required:
        - completed_at
        - created_at
        - file_name
        - file_type
        - has_extraction
        - has_overrides
        - has_translation
        - has_warnings
        - id
        - page_count
        - progress
        - score
        - snippet
        - stage
        - status
        - summary
  securitySchemes:
    extractApiKey:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: |
        Organisation API key from Settings → API / `/api/keys/`. The secret is
        shown once. Send `Authorization: Bearer sk-abacus-…`. One active key
        per organisation. Ingest (`/api/v2/ingest/*`) refuses API keys — that
        surface is Auth0-only with `ingest:read` / `ingest:write` scopes.
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        Auth0 access token for a signed-in user. Send `Authorization: Bearer
        <token>`.

        The SPA and desktop agent use this. Prefer an organisation API key for

        server-to-server integrations.
    cookieAuth:
      type: apiKey
      in: cookie
      name: sessionid
      description: |
        Django session cookie from a browser login. Present so the web app can
        call `/api/v2` without a header. Do not rely on this for integrations.

````