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

# List

> Lists the folders of a document tree, sorted by name, without its root: the top-level folders have no parent.

> [!WARNING]
>
> This endpoint is in preview: it may change without notice until it becomes part of a stable version.


## OpenAPI

````yaml preview post /api/document/resource-folders.list
openapi: 3.1.0
info:
  title: tipee
  version: preview
servers: []
security:
  - basicAuth: []
tags:
  - name: Activity
    description: Activity
  - name: Balances
    description: Balances
  - name: Directory
    description: Directory
  - name: Document
    description: Document
  - name: Expenses
    description: Expenses
  - name: Schedule
    description: Schedule
  - name: Security
    description: Security
  - name: Timeclock
    description: Timeclock
paths:
  /api/document/resource-folders.list:
    post:
      tags:
        - Document
      summary: List
      description: >-
        Lists the folders of a document tree, sorted by name, without its root:
        the top-level folders have no parent.
      operationId: post_app_ui_api_document_documentquery_listresourcefolders
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListResourceFoldersQuery'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/DocumentFolderView'
components:
  schemas:
    ListResourceFoldersQuery:
      required:
        - kind
      properties:
        kind:
          $ref: '#/components/schemas/DocumentTreeKind'
        parent_id:
          $ref: '#/components/schemas/Snowflake'
          description: >-
            Lists the folders below this one rather than below the root of the
            tree.
        depth:
          description: How many levels below the parent to list, every level when omitted.
          type: integer
      type: object
      additionalProperties: false
    DocumentFolderView:
      required:
        - id
        - name
        - parent_id
      properties:
        id:
          $ref: '#/components/schemas/Snowflake'
        name:
          type: string
        parent_id:
          oneOf:
            - $ref: '#/components/schemas/Snowflake'
            - type: 'null'
      type: object
    DocumentTreeKind:
      type: string
      example: employee
      enum:
        - employee
    Snowflake:
      type: string
      format: snowflake
      example: '872815618512410358'

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.