Get Navigation Tree

Get folder structure hierarchy within File Request.

Endpoint

GET /api/v1/requests/{file_request_id}/items?include=tree

Parameters

Path parameters

Parameter	Type	Required	Description
file_request_id	string	yes	-

Query parameters

Parameter	Type	Required	Description
include	string	yes	Use tree to return the folder tree.

Request example

cURL

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

Response

200 OK

[
  {
    "name": "Upload request",
    "location": "upload-request",
    "folders": [
      {
        "id": "folder_123",
        "parent_id": null,
        "name": "Uploads",
        "folders": []
      }
    ],
    "isMovable": true,
    "isOpen": true
  }
]

403 Forbidden

{
  "type": "error",
  "message": "Access Denied"
}

422 Unprocessable Entity

{
  "message": "The given data was invalid.",
  "errors": {
    "field": [
      "The field is required."
    ]
  }
}