List Folders

Retrieve a list of all folders in your workspace. Folders help you organize QR codes by campaign, location, or any structure that works for you.

GET/folders

Folders feature

Folders require the Folders feature to be enabled on your workspace plan. If disabled, this endpoint returns a 403 error.

Headers

Header	Required	Description
X-API-Key	Required	Your API key
QR-Version	Optional	API version (e.g., 2026-02-16)

Query Parameters

Parameter	Type	Default	Description
search	string	—	Filter folders by name (optional)

Request

cURL

curl -X GET "https://integration-api.qr-build.com/folders" \
  -H "X-API-Key: qrb_live_your_api_key_here"

JavaScript

const response = await fetch(
  "https://integration-api.qr-build.com/folders",
  { headers: { "X-API-Key": "qrb_live_your_api_key_here" } }
);

const data = await response.json();

Python

import requests

response = requests.get(
    "https://integration-api.qr-build.com/folders",
    headers={"X-API-Key": "qrb_live_your_api_key_here"},
)

data = response.json()

Response

{
  "object": "list",
  "success": true,
  "data": [
    {
      "id": "fld-aBc123XyZ9",
      "name": "Marketing Campaign",
      "qr_codes_count": 12,
      "created_at": "2026-02-16T10:30:00Z"
    },
    {
      "id": "fld-dEf456UvW2",
      "name": "Product Labels",
      "qr_codes_count": 45,
      "created_at": "2026-02-15T08:00:00Z"
    }
  ]
}

Response Fields

Field	Type	Description
id	string	Unique folder identifier (use this as folder_id when creating/updating QR codes)
name	string	Folder name
qr_codes_count	integer	Number of QR codes in this folder
created_at	string	ISO 8601 creation timestamp

Error — Folders Not Available

{
  "success": false,
  "error": {
    "code": "FEATURE_DISABLED",
    "message": "Folders feature is not available for this workspace"
  }
}