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

# List folders

> List folders, optionally under a parent folder.

<RequestExample>
  ```bash cURL theme={null}
  curl --request GET \
    --url 'https://upload.autorender.io/api/v1/folders?parent_folder_no=sD1LvqoDzG' \
    --header 'Authorization: Bearer YOUR_API_KEY'
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={null}
  {
    "folders": [
      {
        "folder_no": "4bu71SsGmM",
        "name": "demo",
        "created_at": "2026-03-27T15:59:36.104Z",
        "total_items": 0,
        "total_size": 0
      },
      {
        "folder_no": "53855hxPoq",
        "name": "demo2",
        "created_at": "2026-03-27T15:21:40.693Z",
        "total_items": 3,
        "total_size": 1166070
      }
    ]
  }
  ```

  ```json 401 theme={null}
  {
    "success": false,
    "error": "Unauthorized",
    "message": "Invalid or missing API key"
  }
  ```
</ResponseExample>

## Overview

Returns **`folders`**. Each row carries `folder_no`, `name`, `created_at`, `total_items`, and `total_size` (the total bytes under that folder).

## Query parameters

| Parameter          | Type   | Description                                                                   |
| ------------------ | ------ | ----------------------------------------------------------------------------- |
| `parent_folder_no` | string | List only the direct children of this folder. Omit it for root-level folders. |

## Next steps

<CardGroup cols={2}>
  <Card title="Create folder" icon="folder-plus" iconType="solid" href="/docs/api-reference/create-folder">
    Add a new folder, optionally nested under a parent.
  </Card>

  <Card title="List files" icon="list" iconType="solid" href="/docs/api-reference/list-files">
    Page through the files inside a folder.
  </Card>
</CardGroup>


## OpenAPI

````yaml api-reference/openapi.json GET /api/v1/folders
openapi: 3.0.0
info:
  title: AutoRender Public API
  description: >-
    REST API for uploading, managing, and serving media assets. All endpoints
    require an API key via the x-api-key header or Authorization: Bearer <key>.
  version: 1.0.0
  contact:
    name: AutoRender Support
    email: support@autorender.io
servers:
  - url: https://app-api.autorender.io
    description: Production server
security:
  - apiKey: []
tags:
  - name: Uploads
    description: Upload endpoints (API key required)
  - name: Files
    description: File management endpoints (API key required)
  - name: Folders
    description: Folder management endpoints (API key required)
paths:
  /api/v1/folders:
    get:
      tags:
        - Folders
      summary: List folders
      operationId: listFolders
      parameters:
        - schema:
            type: string
          in: query
          name: parent_folder_no
          required: false
          description: Filter by parent folder number
        - schema:
            type: string
          in: query
          name: search
          required: false
          description: Partial name match (case-insensitive)
        - schema:
            default: created_at_desc
            type: string
            enum:
              - name_asc
              - name_desc
              - created_at_asc
              - created_at_desc
          in: query
          name: sort
          required: false
      responses:
        '200':
          description: List of folders
          content:
            application/json:
              schema:
                type: object
                properties:
                  folders:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          format: uuid
                          pattern: >-
                            ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                        folder_no:
                          type: string
                        name:
                          type: string
                        path:
                          type: string
                        parent_folder_no:
                          nullable: true
                          type: string
                        created_at:
                          type: string
                          format: date-time
                          pattern: >-
                            ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
                        updated_at:
                          nullable: true
                          type: string
                          format: date-time
                          pattern: >-
                            ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
                      required:
                        - id
                        - folder_no
                        - name
                        - path
                        - parent_folder_no
                        - created_at
                        - updated_at
                      additionalProperties: false
                required:
                  - folders
                additionalProperties: false
                description: List of folders
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                additionalProperties: false
                description: Unauthorized
        '429':
          description: Rate limit exceeded
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  message:
                    type: string
                  retryAfterSeconds:
                    type: number
                required:
                  - error
                  - message
                additionalProperties: false
                description: Rate limit exceeded
        '503':
          description: Limit service unavailable
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                additionalProperties: false
                description: Limit service unavailable
      security:
        - apiKey: []
components:
  securitySchemes:
    apiKey:
      type: apiKey
      name: x-api-key
      in: header
      description: >-
        API key for public endpoints. Can also be provided via Authorization:
        Bearer <key>

````