Get

[POST] .../v1/folder/get

Returns a list of folders with ACL applied. Use this method to retrieve the folder tree entries visible to the current request user before showing file storage navigation or choosing a target folder for uploads and moves. The response returns paged folder records with id, name, generated path, parent_id, owner, access_level, deleted flag, next_offset and total. The request body is required and supports filters id, parent_id, user_id, access_level and name while keeping ids and search as aliases; the current runtime returns folders ordered by name. The folders module requires database version 365 or later and access is limited by folder select permission, ownership, public access, root-folder visibility and the permission to work with all folders; missing body, denied permission, unsupported database version, invalid filters and database errors are returned as HTTP 200 ErrorResult business errors.

Request Parameters

Name Type Required Description
filters Array of Filter Optional Optional filters by fields available for this API method.
limit Int32 Optional Maximum number of records to return. The value is limited by server settings.
offset Int32 Optional Offset from the beginning of the result set.
search String Optional Search by folder name.
sort_orders Array of BaseSortColumn Optional Sorting field. Current Folder/Get runtime returns folders ordered by name.

Filterable Fields

Field Type Description
access_level string Access level filter.
id int Filter by folder IDs.
name string
parent_id int Filter by parent folder.
user_id int Owner filter.

Request Example

{
  "filters": [
    {
      "field": "parent_id",
      "operator": "Equal",
      "value": "1"
    },
    {
      "field": "access_level",
      "operator": "Equal",
      "value": "Personal"
    },
    {
      "field": "name",
      "operator": "Like",
      "value": "invoice"
    }
  ],
  "limit": 50,
  "offset": 0
}

Response Parameters

Name Type Description
next_offset Int32 Offset for the next data page.
ok Boolean Indicates whether the request completed successfully.
result Array of CommonFolder Result array.
total Int64 Total number of result items.

Response Example

{
  "ok": true,
  "result": [
    {
      "id": 10,
      "name": "Invoices",
      "path": "/Invoices",
      "parent_id": 1,
      "user_id": 501,
      "access_level": "personal",
      "date": 1767139200,
      "last_update": 1767139200,
      "deleted": false
    }
  ],
  "next_offset": 0,
  "total": 1
}