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

# List Path Parts Handler

> List path parts (folders) under a parent with traversal.

This is a generic endpoint for traversing the folder hierarchy. It returns
only FOLDER type path parts.

- If parent_path_id is not provided, lists contents of the root folder.
- max_depth controls how deep to traverse (1 = direct children only).
- sort_order controls the ordering: LOGICAL (linked-list), NAME, UPDATED_AT, CREATED_AT.

For listing folder contents that includes documents with enriched metadata,
use GET /folders/{folder_id}/contents instead.



## OpenAPI

````yaml /openapi.yaml get /v1/path-parts
openapi: 3.1.0
info:
  title: Knowledge Stack API
  description: Knowledge Stack backend API for authentication and knowledge management
  version: 0.1.0
servers:
  - url: http://localhost:8000
    description: Knowledge Stack API local dev server
security: []
tags:
  - name: auth
    description: Authentication and identity management
  - name: users
    description: User accounts
  - name: tenants
    description: Tenant management
  - name: invites
    description: Tenant invitations
  - name: folders
    description: Folder management
  - name: documents
    description: Document management
  - name: document-versions
    description: Document version management
  - name: sections
    description: Document sections
  - name: chunks
    description: Chunk CRUD and semantic search
  - name: chunk-lineages
    description: Chunk lineage tracking
  - name: tags
    description: Tag management
  - name: path-parts
    description: Path part traversal and tagging
  - name: Threads
    description: Thread conversations
  - name: Thread Messages
    description: Thread message management
  - name: user-permissions
    description: User path permissions
  - name: workflows
    description: Ingestion workflows
paths:
  /v1/path-parts:
    get:
      tags:
        - path-parts
      summary: List Path Parts Handler
      description: >-
        List path parts (folders) under a parent with traversal.


        This is a generic endpoint for traversing the folder hierarchy. It
        returns

        only FOLDER type path parts.


        - If parent_path_id is not provided, lists contents of the root folder.

        - max_depth controls how deep to traverse (1 = direct children only).

        - sort_order controls the ordering: LOGICAL (linked-list), NAME,
        UPDATED_AT, CREATED_AT.


        For listing folder contents that includes documents with enriched
        metadata,

        use GET /folders/{folder_id}/contents instead.
      operationId: list_path_parts
      parameters:
        - name: parent_path_id
          in: query
          required: false
          schema:
            type: string
            format: uuid
            nullable: true
            description: Parent PathPart ID (defaults to root)
            title: Parent Path Id
          description: Parent PathPart ID (defaults to root)
        - name: max_depth
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            description: 'Maximum depth to traverse (1 = direct children, default: 1)'
            default: 1
            title: Max Depth
          description: 'Maximum depth to traverse (1 = direct children, default: 1)'
        - name: sort_order
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/PathOrder'
            description: 'Sort order for results (default: LOGICAL)'
            default: LOGICAL
          description: 'Sort order for results (default: LOGICAL)'
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            maximum: 100
            minimum: 1
            description: Number of items per page
            default: 20
            title: Limit
          description: Number of items per page
        - name: offset
          in: query
          required: false
          schema:
            type: integer
            minimum: 0
            description: Number of items to skip
            default: 0
            title: Offset
          description: Number of items to skip
        - name: authorization
          in: header
          required: false
          schema:
            type: string
            nullable: true
            title: Authorization
        - name: ks_uat
          in: cookie
          required: false
          schema:
            type: string
            nullable: true
            title: Ks Uat
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedResponse_PathPartResponse_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    PathOrder:
      type: string
      enum:
        - LOGICAL
        - NAME
        - UPDATED_AT
        - CREATED_AT
      title: PathOrder
      description: >-
        Ordering strategy for path traversal results.


        - LOGICAL: Use prev/next_sibling_path_part_id linked list order per
        depth level

        - NAME: Alphabetical by path_part.name (DEFAULT)

        - UPDATED_AT: By updated_at timestamp (most recent first)

        - CREATED_AT: By created_at timestamp (oldest first)
    PaginatedResponse_PathPartResponse_:
      properties:
        items:
          items:
            $ref: '#/components/schemas/PathPartResponse'
          type: array
          title: Items
          description: List of items
        total:
          type: integer
          minimum: 0
          title: Total
          description: Total number of items
        limit:
          type: integer
          minimum: 1
          title: Limit
          description: Number of items per page
        offset:
          type: integer
          minimum: 0
          title: Offset
          description: Number of items to skip
      additionalProperties: false
      type: object
      required:
        - items
        - total
        - limit
        - offset
      title: PaginatedResponse[PathPartResponse]
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    PathPartResponse:
      properties:
        path_part_id:
          type: string
          format: uuid
          title: Path Part Id
          description: PathPart ID
        name:
          type: string
          title: Name
          description: Item name
        part_type:
          $ref: '#/components/schemas/PartType'
          description: Type (FOLDER, DOCUMENT, etc.)
        parent_path_id:
          type: string
          format: uuid
          nullable: true
          title: Parent Path Id
          description: Parent PathPart ID
        metadata_obj_id:
          type: string
          format: uuid
          nullable: true
          title: Metadata Obj Id
          description: ID of the underlying object
        materialized_path:
          type: string
          title: Materialized Path
          description: Full materialized path from root
        system_managed:
          type: boolean
          title: System Managed
          description: Whether this path part is system-managed
        tags:
          items:
            $ref: '#/components/schemas/TagResponse'
          type: array
          nullable: true
          title: Tags
          description: Tags attached to this path part
        can_read:
          type: boolean
          title: Can Read
          description: Whether the current user can read
        can_write:
          type: boolean
          title: Can Write
          description: Whether the current user can write
        created_at:
          type: string
          format: date-time
          title: Created At
          description: Creation timestamp
        updated_at:
          type: string
          format: date-time
          title: Updated At
          description: Last update timestamp
      additionalProperties: false
      type: object
      required:
        - path_part_id
        - name
        - part_type
        - parent_path_id
        - metadata_obj_id
        - materialized_path
        - system_managed
        - can_read
        - can_write
        - created_at
        - updated_at
      title: PathPartResponse
      description: Generic path part response model.
    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
    PartType:
      type: string
      enum:
        - FOLDER
        - DOCUMENT
        - DOCUMENT_VERSION
        - SECTION
        - CHUNK
        - THREAD
        - THREAD_MESSAGE
        - WORKFLOW_DEFINITION
        - WORKFLOW_RUN
      title: PartType
      description: Type of path part in the filesystem.
    TagResponse:
      properties:
        id:
          type: string
          format: uuid
          title: Id
          description: Tag ID
        name:
          type: string
          title: Name
          description: Tag name
        color:
          type: string
          title: Color
          description: Tag color hex
        description:
          type: string
          nullable: true
          title: Description
          description: Tag description
        tenant_id:
          type: string
          format: uuid
          title: Tenant Id
          description: Tenant ID
        created_at:
          type: string
          format: date-time
          title: Created At
          description: Creation timestamp
        updated_at:
          type: string
          format: date-time
          title: Updated At
          description: Last update timestamp
      additionalProperties: false
      type: object
      required:
        - id
        - name
        - color
        - tenant_id
        - created_at
        - updated_at
      title: TagResponse
      description: Tag response model.

````