Skip to main content
GET
List Folders

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

List Page Folders

Example Response

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[]