Get a folder structure
Headers
-
Content-Type string
-
Accept string
GET
/api/v1/folder/{folder_uuid}/tree
curl \
-X GET https://api.plannrcrm.com/api/v1/folder/folder_uuid/tree \
-H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
Response examples (200)
{
"name": "Important Documents",
"path": "Codepotato/Important Documents",
"slug": "important-documents",
"uuid": "867d19f4-245f-4464-b5b2-7ca52e65ff64",
"depth": 5,
"files": [
{
"firm": "App\\Http\\Resources\\FirmResource",
"name": "Welcome to Plannr",
"size": "21691783",
"tags": "App\\Http\\Resources\\TagResource",
"type": "type",
"uuid": "b01ec604-600d-4b8d-bf5b-7b11a535b40d",
"parent": "Object",
"status": "uploaded",
"account": "App\\Http\\Resources\\AccountResource",
"filename": "Welcome to Plannr.pdf",
"progress": "100",
"extension": "pdf",
"created_at": "2025-01-20T23:10:35+00:00",
"updated_at": "2025-01-20T23:10:35+00:00",
"folder_name": "folder 2",
"uploaded_at": "2025-01-20T23:10:35+00:00",
"download_url": "https://plannr.valet/file/e61a629e-5f2e-4b4f-ad47-392f1bb01a48/download",
"last_modified": "2025-01-20T23:10:35+00:00",
"original_created_at": "2025-01-20T23:10:35+00:00"
}
],
"owned": false,
"folders": [
{
"name": "Important Documents",
"path": "Codepotato/Important Documents",
"slug": "important-documents",
"uuid": "08e48461-9ebc-4843-9040-337f691c5f48",
"depth": 5,
"files": "App\\Http\\Resources\\FileResource",
"owned": false,
"folders": "App\\Http\\Resources\\FolderResource",
"parents": "App\\Http\\Resources\\FolderResource",
"children": "App\\Http\\Resources\\FolderResource",
"ancestors": "App\\Http\\Resources\\FolderResource",
"created_at": "2025-01-20T23:10:35+00:00",
"updated_at": "2025-01-20T23:10:35+00:00",
"files_count": 8,
"clients_read": true,
"participants": "App\\Http\\Resources\\FolderParticipantResource",
"clients_write": true,
"folders_count": 5,
"is_root_folder": true,
"is_pseudo_folder": true,
"is_system_folder": true,
"participants_count": 3,
"show_client_permissions": true
}
],
"parents": [
{
"name": "Important Documents",
"path": "Codepotato/Important Documents",
"slug": "important-documents",
"uuid": "474e2771-4ce7-41f0-af47-c294f29130a5",
"depth": 5,
"files": "App\\Http\\Resources\\FileResource",
"owned": false,
"folders": "App\\Http\\Resources\\FolderResource",
"parents": "App\\Http\\Resources\\FolderResource",
"children": "App\\Http\\Resources\\FolderResource",
"ancestors": "App\\Http\\Resources\\FolderResource",
"created_at": "2025-01-20T23:10:35+00:00",
"updated_at": "2025-01-20T23:10:35+00:00",
"files_count": 8,
"clients_read": true,
"participants": "App\\Http\\Resources\\FolderParticipantResource",
"clients_write": true,
"folders_count": 5,
"is_root_folder": true,
"is_pseudo_folder": true,
"is_system_folder": true,
"participants_count": 3,
"show_client_permissions": true
}
],
"children": [
{
"name": "Important Documents",
"path": "Codepotato/Important Documents",
"slug": "important-documents",
"uuid": "9bb8bb7f-a3ac-4a83-bfe6-8cdab37f3c3f",
"depth": 5,
"files": "App\\Http\\Resources\\FileResource",
"owned": false,
"folders": "App\\Http\\Resources\\FolderResource",
"parents": "App\\Http\\Resources\\FolderResource",
"children": "App\\Http\\Resources\\FolderResource",
"ancestors": "App\\Http\\Resources\\FolderResource",
"created_at": "2025-01-20T23:10:35+00:00",
"updated_at": "2025-01-20T23:10:35+00:00",
"files_count": 8,
"clients_read": true,
"participants": "App\\Http\\Resources\\FolderParticipantResource",
"clients_write": true,
"folders_count": 5,
"is_root_folder": true,
"is_pseudo_folder": true,
"is_system_folder": true,
"participants_count": 3,
"show_client_permissions": true
}
],
"ancestors": [
{
"name": "Important Documents",
"path": "Codepotato/Important Documents",
"slug": "important-documents",
"uuid": "05f04c8c-0021-4856-8771-3663b91559b3",
"depth": 5,
"files": "App\\Http\\Resources\\FileResource",
"owned": false,
"folders": "App\\Http\\Resources\\FolderResource",
"parents": "App\\Http\\Resources\\FolderResource",
"children": "App\\Http\\Resources\\FolderResource",
"ancestors": "App\\Http\\Resources\\FolderResource",
"created_at": "2025-01-20T23:10:35+00:00",
"updated_at": "2025-01-20T23:10:35+00:00",
"files_count": 8,
"clients_read": true,
"participants": "App\\Http\\Resources\\FolderParticipantResource",
"clients_write": true,
"folders_count": 5,
"is_root_folder": true,
"is_pseudo_folder": true,
"is_system_folder": true,
"participants_count": 3,
"show_client_permissions": true
}
],
"created_at": "2025-01-20T23:10:35+00:00",
"updated_at": "2025-01-20T23:10:35+00:00",
"files_count": 8,
"clients_read": true,
"participants": [
{
"name": "Gareth Thompson",
"uuid": "1b2c2120-23f2-4dcc-aefa-a2cff16046ac",
"write": true,
"created_at": "2025-01-20T23:10:35+00:00",
"updated_at": "2025-01-20T23:10:35+00:00"
}
],
"clients_write": true,
"folders_count": 5,
"is_root_folder": true,
"is_pseudo_folder": true,
"is_system_folder": true,
"participants_count": 3,
"show_client_permissions": true
}