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

# List Folders

> Retrieves folders by type (QR or Page). Requires authentication.

## Overview

Retrieves all folders by type (QR or Page). This endpoint returns a paginated list of folders to organize your QR codes or pages.

## Query Parameters

| Parameter     | Type     | Required | Description                                        | Example        |
| :------------ | :------- | :------- | :------------------------------------------------- | :------------- |
| `folder_type` | `string` | Yes      | Folder type to list. Allowed values: `qr`, `page`. | `qr` or `page` |

## Response

The response is a paginated list with the following structure:

* **`count`**: Total number of folders
* **`next`**: URL for next page (null if no more pages)
* **`previous`**: URL for previous page (null if first page)
* **`results`**: Array of folder objects

## Folder Object

Each folder object contains:

* **`id`**: Folder ID
* **`name`**: Folder name
* **`created_by`**: User ID who created the folder
* **`folder_type`**: Folder type (`qr` or `page`)
* **`qr_codes_count`**: Number of QR codes in the folder
* **`created`**: Creation timestamp
* **`updated`**: Last update timestamp

## Examples

### List QR Code Folders

```bash theme={null}
curl -X GET "https://management.scanova.io/folder/?folder_type=qr" \
  -H "Authorization: YOUR_API_KEY"
```

### List Page Folders

```bash theme={null}
curl -X GET "https://management.scanova.io/folder/?folder_type=page" \
  -H "Authorization: YOUR_API_KEY"
```

### Example Response

```json theme={null}
{
  "count": 4,
  "next": null,
  "previous": null,
  "results": [
    {
      "id": 8,
      "name": "Marketing QRs",
      "created_by": 422,
      "folder_type": "qr",
      "qr_codes_count": 1,
      "created": "2026-03-16T17:57:16.662333+05:30",
      "updated": "2026-03-16T17:57:58.660138+05:30"
    },
    {
      "id": 5,
      "name": "foler23",
      "created_by": 422,
      "folder_type": "qr",
      "qr_codes_count": 0,
      "created": "2026-03-16T16:35:06.097830+05:30",
      "updated": "2026-03-16T16:39:19.471567+05:30"
    }
  ]
}
```

## Use Cases

* **Folder Overview**: Show all folders of a specific type
* **Organization**: Help users select folders when moving QR codes
* **Management**: Track folder usage and activity


## OpenAPI

````yaml GET /folder/
openapi: 3.1.0
info:
  title: Scanova Management API
  description: Management endpoints for tags, trash, and other administrative functions
  version: 1.0.0
servers:
  - url: https://management.scanova.io
    description: Production server
security:
  - apiKeyAuth: []
paths:
  /folder/:
    get:
      tags:
        - Management
      summary: List Folders
      description: Retrieves folders by type (QR or Page). Requires authentication.
      parameters:
        - name: folder_type
          in: query
          required: true
          schema:
            type: string
            enum:
              - qr
              - page
          description: Folder type to list
      responses:
        '200':
          description: List of folders
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    example: 4
                  next:
                    type:
                      - string
                      - 'null'
                    description: Next page URL
                    example: null
                  previous:
                    type:
                      - string
                      - 'null'
                    description: Previous page URL
                    example: null
                  results:
                    type: array
                    items:
                      $ref: '#/components/schemas/Folder'
        '401':
          description: Unauthorized - Invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationErrorResponse'
      security:
        - apiKeyAuth: []
components:
  schemas:
    Folder:
      type: object
      properties:
        id:
          type: integer
          description: Folder ID
          example: 7
        name:
          type: string
          description: Folder name
          example: Marketing QRs
        created_by:
          type: integer
          description: User ID who created the folder
          example: 422
        folder_type:
          type: string
          description: Folder type
          example: qr
        qr_codes_count:
          type: integer
          description: Number of QR codes in the folder
          example: 0
        created:
          type: string
          format: date-time
          description: Creation timestamp
          example: '2026-03-16T17:57:16.662333+05:30'
        updated:
          type: string
          format: date-time
          description: Last update timestamp
          example: '2026-03-16T17:57:16.662362+05:30'
    AuthenticationErrorResponse:
      type: object
      properties:
        detail:
          type: string
          description: Authentication error message
          example: Invalid token.
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: >-
        API key authentication. Enter your API key directly in the Authorization
        header.

````