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

# List available documents

> This endpoint can be used to get the list of available documents for your user account, with optional filtering by workspace, private, or company scope.



## OpenAPI

````yaml /api-reference/openapi-v2.yaml get /api/v2/files
openapi: 3.0.3
info:
  title: Paradigm API
  version: xenial-xerus (v2)
  description: >-
    A versatile and adaptable tool designed to integrate Generative AI into your
    applications
servers:
  - url: https://paradigm.lighton.ai
security: []
tags:
  - name: Models
    description: Operations about AI models
  - name: Files Search
    description: Operations about files search
  - name: Files
    description: Operations about files
  - name: Upload Sessions
    description: Operations about upload sessions
  - name: Workspaces
    description: Operations about workspaces
  - name: Users
    description: Operations about users
  - name: Companies
    description: Operations about companies
  - name: SCIM
    description: Operations about SCIM
  - name: Feedbacks
    description: Operations about feedbacks
  - name: Reporting
    description: Operations about reporting
  - name: Monitoring
    description: Operations about monitoring
  - name: Platform Status
    description: Operations about platform status
paths:
  /api/v2/files:
    get:
      tags:
        - Files
      summary: List available documents
      description: >-
        This endpoint can be used to get the list of available documents for
        your user account, with optional filtering by workspace, private, or
        company scope.
      operationId: api_v2_files_list
      parameters:
        - in: query
          name: company_scope
          schema:
            type: boolean
          description: Include documents from the company collection if True.
        - in: query
          name: include_details
          schema:
            type: boolean
          description: >-
            Include detail fields (e.g., TLSH signature for duplicate
            detection). Default: false.
        - name: page
          required: false
          in: query
          description: A page number within the paginated result set.
          schema:
            type: integer
        - in: query
          name: private_scope
          schema:
            type: boolean
          description: Include documents from the user's private collection if True.
        - in: query
          name: tags
          schema:
            type: string
          description: Comma-separated list of tag IDs to filter by.
        - in: query
          name: workspace_scope
          schema:
            type: integer
          description: Include documents contained in workspace with ID given.
          explode: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/PaginatedPaginatedFileListResponseSerializerV2List
          description: ''
      security:
        - bearerAuth: []
components:
  schemas:
    PaginatedPaginatedFileListResponseSerializerV2List:
      type: object
      properties:
        object:
          type: string
          example: list
        count:
          type: integer
          example: 123
        next:
          type: string
          nullable: true
          format: uri
          example: https://paradigm.lighton.ai/api/v2/files/?page=4
        previous:
          type: string
          nullable: true
          format: uri
          example: https://paradigm.lighton.ai/api/v2/files/?page=2
        data:
          type: array
          items:
            $ref: '#/components/schemas/PaginatedFileListResponseSerializerV2'
    PaginatedFileListResponseSerializerV2:
      type: object
      description: Paginated response serializer for file list endpoint.
      properties:
        object:
          type: string
          default: list
          description: Object type, always 'list' for paginated responses
        count:
          type: integer
          description: Total number of files across all pages
        next:
          type: string
          format: uri
          nullable: true
          description: URL for the next page of results (null if this is the last page)
        previous:
          type: string
          format: uri
          nullable: true
          description: >-
            URL for the previous page of results (null if this is the first
            page)
        data:
          type: array
          items:
            $ref: '#/components/schemas/FileListResponseSerializerV2'
          description: Array of file objects for the current page
      required:
        - count
        - data
    FileListResponseSerializerV2:
      type: object
      description: Response serializer for file list results.
      properties:
        id:
          type: integer
          description: Unique identifier for the file
        object:
          type: string
          readOnly: true
          description: Object type, always 'file'
        created_at:
          type: integer
          readOnly: true
          description: Unix timestamp of when the file was created
        filename:
          type: string
          readOnly: true
          description: Original filename of the file
        purpose:
          type: string
          readOnly: true
          description: Purpose of the file, always 'documents'
        status:
          type: string
          readOnly: true
          description: Processing status of the file
        signature:
          type: string
          nullable: true
          description: >-
            TLSH hash for duplicate detection. Only included when
            include_details=true (detail field).
          readOnly: true
      required:
        - created_at
        - filename
        - id
        - object
        - purpose
        - signature
        - status
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Bearer authentication header of the form `Bearer <token>`, where
        `<token>` is your auth token.

````