# List documents

> GET /api/v1/knowledge-base/documents — request parameters and responses from the Menace Voice API schema.

`GET /api/v1/knowledge-base/documents`

{/* Generated by scripts/sync_docs_api.mjs. Edit the API schema source to change the contract. */}

See [authentication](/api-reference/authentication) for workspace API access. Public embed and artifact endpoints use their documented session or access tokens.

## API contract for documentation tools

Generated from the OpenAPI schema. Do not infer a different parameter type from an example. Authentication headers are alternatives as explained in the authentication guide.

### Parameters

| Name | Location | Type | Required | Description and constraints |
| --- | --- | --- | --- | --- |
| status | query | string or null | no | Filter by processing status |
| limit | query | integer | no | default: 100; minimum: 1; maximum: 100 |
| offset | query | integer | no | default: 0; minimum: 0 |
| authorization | header | string or null | no |  |
| X-API-Key | header | string or null | no |  |

### Response 200

Successful Response

application/json: DocumentListResponseSchema (object).

| Field | Type | Required | Description and constraints |
| --- | --- | --- | --- |
| documents | array of DocumentResponseSchema (object) | yes |  |
| total | integer | yes |  |
| limit | integer | yes |  |
| offset | integer | yes |  |

### Response 404

Not found

### Response 422

Validation Error

application/json: HTTPValidationError (object).

| Field | Type | Required | Description and constraints |
| --- | --- | --- | --- |
| detail | array of ValidationError (object) | no |  |

## OpenAPI

````yaml api-reference/openapi.json get /api/v1/knowledge-base/documents
openapi: 3.1.0
info:
  title: Menace Voice API
  description: API for Menace Voice agents
  version: 1.0.0
servers:
  - url: https://voice.menaceui.com
    description: Production
  - url: http://localhost:8000
    description: Local development
paths:
  /api/v1/knowledge-base/documents:
    get:
      tags:
        - main
        - knowledge-base
      summary: List documents
      description: |-
        List all documents for the user's organization.

        Access Control:
        * Users can only see documents from their organization.
      operationId: list_documents_api_v1_knowledge_base_documents_get
      parameters:
        - name: status
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: "null"
            description: Filter by processing status
            title: Status
          description: Filter by processing status
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            maximum: 100
            minimum: 1
            default: 100
            title: Limit
        - name: offset
          in: query
          required: false
          schema:
            type: integer
            minimum: 0
            default: 0
            title: Offset
        - name: authorization
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: "null"
            title: Authorization
        - name: X-API-Key
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: "null"
            title: X-Api-Key
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DocumentListResponseSchema"
        "404":
          description: Not found
        "422":
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/HTTPValidationError"
      x-sdk-method: list_documents
      x-sdk-description: List knowledge base documents available to the authenticated
        organization.
components:
  schemas:
    DocumentListResponseSchema:
      properties:
        documents:
          items:
            $ref: "#/components/schemas/DocumentResponseSchema"
          type: array
          title: Documents
        total:
          type: integer
          title: Total
        limit:
          type: integer
          title: Limit
        offset:
          type: integer
          title: Offset
      type: object
      required:
        - documents
        - total
        - limit
        - offset
      title: DocumentListResponseSchema
      description: Response schema for list of documents.
    DocumentResponseSchema:
      properties:
        id:
          type: integer
          title: Id
        document_uuid:
          type: string
          title: Document Uuid
        filename:
          type: string
          title: Filename
        file_size_bytes:
          type: integer
          title: File Size Bytes
        file_hash:
          type: string
          title: File Hash
        mime_type:
          type: string
          title: Mime Type
        processing_status:
          type: string
          title: Processing Status
        processing_error:
          anyOf:
            - type: string
            - type: "null"
          title: Processing Error
        total_chunks:
          type: integer
          title: Total Chunks
        retrieval_mode:
          type: string
          title: Retrieval Mode
          default: chunked
        custom_metadata:
          additionalProperties: true
          type: object
          title: Custom Metadata
        docling_metadata:
          additionalProperties: true
          type: object
          title: Docling Metadata
        source_url:
          anyOf:
            - type: string
            - type: "null"
          title: Source Url
        content:
          anyOf:
            - type: string
            - type: "null"
          title: Content
          description: Extracted document content for preview when processing is complete
        created_at:
          type: string
          format: date-time
          title: Created At
        updated_at:
          type: string
          format: date-time
          title: Updated At
        organization_id:
          type: integer
          title: Organization Id
        created_by:
          type: integer
          title: Created By
        is_active:
          type: boolean
          title: Is Active
      type: object
      required:
        - id
        - document_uuid
        - filename
        - file_size_bytes
        - file_hash
        - mime_type
        - processing_status
        - total_chunks
        - custom_metadata
        - docling_metadata
        - created_at
        - updated_at
        - organization_id
        - created_by
        - is_active
      title: DocumentResponseSchema
      description: Response schema for document metadata.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: "#/components/schemas/ValidationError"
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
````