Headers
-
Content-Type string
-
Accept string
GET
/api/v1/folder/{folder_uuid}/tree
curl \
--request GET https://api.plannrcrm.com/api/v1/folder/folder_uuid/tree \
--header "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
Response examples (200)
{
"name": "Important Documents",
"path": "Codepotato/Important Documents",
"slug": "important-documents",
"uuid": "2521de10-99b5-47df-8426-bccf4887a23d",
"depth": 5,
"files": [
{
"firm": "App\\Http\\Resources\\FirmResource",
"name": "Welcome to Plannr",
"path": "Gareth Thompson/Subfolder/Welcome to Plannr.pdf",
"size": "21691783",
"tags": "App\\Http\\Resources\\TagResource",
"type": "type",
"uuid": "8eb4b5d9-6f1a-4c4f-ba99-1e63f5d14307",
"folder": "App\\Http\\Resources\\FolderResource",
"status": "uploaded",
"account": "App\\Http\\Resources\\MinimalAccountResource",
"filename": "Welcome to Plannr.pdf",
"progress": "100",
"extension": "pdf",
"navigator": {
"model_type": "account",
"model_uuid": "d58eb43b-3c87-4efa-81c2-d72f16fead81"
},
"created_at": "2025-02-20T10:13:03+00:00",
"updated_at": "2025-02-20T10:13:03+00:00",
"folder_name": "folder 2",
"uploaded_at": "2025-02-20T10:13:03+00:00",
"documentable": "Object",
"download_url": "https://plannr.valet/file/016baed3-b2d0-4e88-b9d3-0c4f0a9de8a2/download",
"last_modified": "2025-02-20T10:13:03+00:00",
"documentable_type": "account",
"original_created_at": "2025-02-20T10:13:03+00:00"
}
],
"owned": false,
"folders": [
{
"name": "Important Documents",
"path": "Codepotato/Important Documents",
"slug": "important-documents",
"uuid": "2ae75398-b3dd-427d-bdf0-ad98b48ac022",
"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-02-20T10:13:03+00:00",
"updated_at": "2025-02-20T10:13:03+00:00",
"files_count": 8,
"clients_read": true,
"documentable": "Object",
"participants": "App\\Http\\Resources\\FolderParticipantResource",
"clients_write": true,
"folders_count": 5,
"is_root_folder": true,
"is_pseudo_folder": true,
"is_system_folder": true,
"documentable_type": "account",
"documentable_uuid": "account",
"participants_count": 3,
"show_client_permissions": true
}
],
"parents": [
{
"name": "Important Documents",
"path": "Codepotato/Important Documents",
"slug": "important-documents",
"uuid": "7dbed4e0-c3e6-4983-8477-22854e7ea2cb",
"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-02-20T10:13:03+00:00",
"updated_at": "2025-02-20T10:13:03+00:00",
"files_count": 8,
"clients_read": true,
"documentable": "Object",
"participants": "App\\Http\\Resources\\FolderParticipantResource",
"clients_write": true,
"folders_count": 5,
"is_root_folder": true,
"is_pseudo_folder": true,
"is_system_folder": true,
"documentable_type": "account",
"documentable_uuid": "account",
"participants_count": 3,
"show_client_permissions": true
}
],
"children": [
{
"name": "Important Documents",
"path": "Codepotato/Important Documents",
"slug": "important-documents",
"uuid": "33f8f3a6-dbc3-4cdd-9cdf-d0f7a84a43a9",
"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-02-20T10:13:03+00:00",
"updated_at": "2025-02-20T10:13:03+00:00",
"files_count": 8,
"clients_read": true,
"documentable": "Object",
"participants": "App\\Http\\Resources\\FolderParticipantResource",
"clients_write": true,
"folders_count": 5,
"is_root_folder": true,
"is_pseudo_folder": true,
"is_system_folder": true,
"documentable_type": "account",
"documentable_uuid": "account",
"participants_count": 3,
"show_client_permissions": true
}
],
"ancestors": [
{
"name": "Important Documents",
"path": "Codepotato/Important Documents",
"slug": "important-documents",
"uuid": "bdc56c5e-5d2d-4163-abaa-b04cb03b8e47",
"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-02-20T10:13:03+00:00",
"updated_at": "2025-02-20T10:13:03+00:00",
"files_count": 8,
"clients_read": true,
"documentable": "Object",
"participants": "App\\Http\\Resources\\FolderParticipantResource",
"clients_write": true,
"folders_count": 5,
"is_root_folder": true,
"is_pseudo_folder": true,
"is_system_folder": true,
"documentable_type": "account",
"documentable_uuid": "account",
"participants_count": 3,
"show_client_permissions": true
}
],
"created_at": "2025-02-20T10:13:03+00:00",
"updated_at": "2025-02-20T10:13:03+00:00",
"files_count": 8,
"clients_read": true,
"documentable": "Object",
"participants": [
{
"name": "Gareth Thompson",
"uuid": "9d0dd8c5-3290-4bdb-8f29-7415249e3992",
"write": true,
"created_at": "2025-02-20T10:13:03+00:00",
"updated_at": "2025-02-20T10:13:03+00:00"
}
],
"clients_write": true,
"folders_count": 5,
"is_root_folder": true,
"is_pseudo_folder": true,
"is_system_folder": true,
"documentable_type": "account",
"documentable_uuid": "account",
"participants_count": 3,
"show_client_permissions": true
}