Skip to main content
GET
/
folder
List Folders
curl --request GET \
  --url https://management.scanova.io/folder/ \
  --header 'Authorization: <api-key>'
{
  "count": 4,
  "next": null,
  "previous": null,
  "results": [
    {
      "id": 7,
      "name": "Marketing QRs",
      "created_by": 422,
      "folder_type": "qr",
      "qr_codes_count": 0,
      "created": "2026-03-16T17:57:16.662333+05:30",
      "updated": "2026-03-16T17:57:16.662362+05:30"
    }
  ]
}

​
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

ParameterTypeRequiredDescriptionExample
folder_typestringYesFolder 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

curl -X GET "https://management.scanova.io/folder/?folder_type=qr" \
  -H "Authorization: YOUR_API_KEY"

​
List Page Folders

curl -X GET "https://management.scanova.io/folder/?folder_type=page" \
  -H "Authorization: YOUR_API_KEY"

​
Example Response

{
  "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

Authorizations

​
Authorization
string
header
required

API key authentication. Enter your API key directly in the Authorization header.

Query Parameters

​
folder_type
enum<string>
required

Folder type to list

Available options:
qr,
page

Response

List of folders

​
count
integer
Example:

4

​
next
string | null

Next page URL

Example:

null

​
previous
string | null

Previous page URL

Example:

null

​
results
object[]