Skip to content

Get Navigation Tree

Get folder navigation hierarchy of shared folder.

Endpoint

http
GET /api/v1/shares/{token}/items?include=tree

Parameters

Path parameters

ParameterTypeRequiredDescription
tokenstringyes-

Query parameters

ParameterTypeRequiredDescription
includestringyesUse tree to return the folder tree.

Request example

sh
curl --location --request GET 'https://files.ro/api/v1/shares/{token}/items?include=tree' \

Response

json
[
  {
    "name": "Home",
    "location": "public",
    "folders": [
      {
        "id": "folder_123",
        "parent_id": null,
        "name": "Shared",
        "folders": []
      }
    ],
    "isMovable": true,
    "isOpen": true
  }
]
json
{
  "type": "error",
  "message": "Access Denied"
}
json
{
  "message": "The given data was invalid.",
  "errors": {
    "field": [
      "The field is required."
    ]
  }
}