> ## 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 (v2)
  description: >-
    The complete Scanova Management API — every endpoint available at
    management.scanova.io (QR codes, folders, tags, leads, forms, analytics,
    plans, shared users & roles), plus the token-creation and usage-stats
    endpoints used to authenticate against it. Every path and request/response
    shape below was verified live against a real API key and the actual running
    backend (Phase 7, 2026-08-16) — not guessed from reading urls.py alone.
  version: 2.0.0
servers:
  - url: https://management.scanova.io
    description: Management API — QR/folder/tag/lead/form/analytics/plans endpoints
security:
  - apiKeyAuth: []
paths:
  /folder/:
    get:
      summary: List folders
      operationId: listManagedFolders
      responses:
        '200':
          description: List of folders
components:
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: >-
        Send your Management API key as the raw value of the Authorization
        header — no "Bearer " or "Token " prefix, and no other characters.
        Example: `Authorization: 401f7ac837da42b97f613d789819ff93537bee6a`. A
        header containing more than one space-separated part is rejected
        outright. Requests also require the request's Host header to be the
        management API host (e.g. management.scanova.io) — the same key sent to
        the regular API host will not authenticate.

````