List Folders

GET/apiv2/pub/foldersdocuments_read

Returns a paginated list of folders accessible to the token's user, sorted alphabetically by full path.

Request

Query parameters

Parameter	Type	Default	Description
q	string	—	Filter by name (case-insensitive substring).
parent_id	integer	—	Only direct children of this folder. 0 = root only.
limit	integer	50	Page size.
offset	integer	0	Pagination offset.

---

Response

200 OK — Array of folders

Field	Type	Description
folder_id	integer	Unique folder ID.
name	string	Folder display name (final segment of path).
full_path	string	Full path (e.g. "Finance->Invoices->2025").
parent_id	integer	Parent folder ID. 0 = root.
code	string	Unique UUID code.
child_count	integer	Number of direct child folders.

---

Errors

Status	Reason
401	Invalid or expired token
403	Token lacks documents_read scope

cURL

curl -i -X GET "https://portal.docwize.com/apiv2/pub/folders?parent_id=0" \
     -H "Authorization: Bearer <ACCESS_TOKEN>"

---

[
  {
    "folder_id": 10,
    "name": "Finance",
    "full_path": "Finance",
    "parent_id": 0,
    "code": "a1b2c3d4-...",
    "child_count": 3
  },
  {
    "folder_id": 42,
    "name": "Invoices",
    "full_path": "Finance->Invoices",
    "parent_id": 10,
    "code": "e5f6a7b8-...",
    "child_count": 0
  }
]

{"detail": "Invalid or expired token"}