GET
/api/v1/folder/{uuid}
curl \
--request GET 'https://api.plannrcrm.com/api/v1/folder/6ff8f7f6-1eb3-3525-be4a-3932c805afed' \
--header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200)
{
"name": "Important Documents",
"path": "Codepotato/Important Documents",
"slug": "important-documents",
"uuid": "c2f3dd24-c315-4c24-9f90-4e271e9dd6a1",
"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": "7ae46de3-280d-4a89-94be-da9e00f31c8a",
"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": "4c592220-c12e-47e9-b542-7c2ed76026b7"
},
"created_at": "2025-08-27T17:31:26+01:00",
"updated_at": "2025-08-27T17:31:26+01:00",
"folder_name": "folder 2",
"uploaded_at": "2025-08-27T17:31:26+01:00",
"documentable": "Object",
"download_url": "https://api.plannrcrm.com/file/ff7ce0b6-bd6e-4621-ab2c-089ee93f8a7f/download",
"last_modified": "2025-08-27T17:31:26+01:00",
"documentable_type": "account",
"original_created_at": "2025-08-27T17:31:26+01:00"
}
],
"owned": false,
"folders": [
{
"name": "Important Documents",
"path": "Codepotato/Important Documents",
"slug": "important-documents",
"uuid": "addf57b0-a291-4563-8fa2-7969f0efb977",
"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-08-27T17:31:26+01:00",
"updated_at": "2025-08-27T17:31:26+01: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": "490a3806-b459-47cc-8b6b-7313aebc62e5",
"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-08-27T17:31:26+01:00",
"updated_at": "2025-08-27T17:31:26+01: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": "0b16fd98-9017-446a-a800-b82be707fabb",
"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-08-27T17:31:26+01:00",
"updated_at": "2025-08-27T17:31:26+01: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": "ec305bae-18f2-4446-87ce-3d6010bc7724",
"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-08-27T17:31:26+01:00",
"updated_at": "2025-08-27T17:31:26+01: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-08-27T17:31:26+01:00",
"updated_at": "2025-08-27T17:31:26+01:00",
"files_count": 8,
"clients_read": true,
"documentable": "Object",
"participants": [
{
"name": "Gareth Thompson",
"uuid": "b057aae1-724e-4b1d-8460-cea747de9111",
"write": true,
"created_at": "2025-08-27T17:31:26+01:00",
"updated_at": "2025-08-27T17:31:26+01: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
}