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": "7a5cb674-8e0e-4b7b-8237-24b148d28b44",
"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": "6b86a567-442c-4a2a-85e4-ca620a880010",
"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": "378a2ccc-a782-4237-b61d-05b73e08a1d5"
},
"created_at": "2025-08-07T13:41:42+01:00",
"updated_at": "2025-08-07T13:41:42+01:00",
"folder_name": "folder 2",
"uploaded_at": "2025-08-07T13:41:42+01:00",
"documentable": "Object",
"download_url": "https://api.plannrcrm.com/file/2b80ef3b-39bb-4d5e-92f6-29fccd5734f9/download",
"last_modified": "2025-08-07T13:41:42+01:00",
"documentable_type": "account",
"original_created_at": "2025-08-07T13:41:42+01:00"
}
],
"owned": false,
"folders": [
{
"name": "Important Documents",
"path": "Codepotato/Important Documents",
"slug": "important-documents",
"uuid": "5821f7d2-1850-483d-adcb-ad4abb0af232",
"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-07T13:41:42+01:00",
"updated_at": "2025-08-07T13:41:42+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": "a9b0fbcc-cdb9-4832-9830-b81717d4e82b",
"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-07T13:41:42+01:00",
"updated_at": "2025-08-07T13:41:42+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": "fc122ad7-350b-458d-aa1c-8a713041dfff",
"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-07T13:41:42+01:00",
"updated_at": "2025-08-07T13:41:42+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": "857a1786-2279-46b5-96a0-2b6a048b44bd",
"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-07T13:41:42+01:00",
"updated_at": "2025-08-07T13:41:42+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-07T13:41:42+01:00",
"updated_at": "2025-08-07T13:41:42+01:00",
"files_count": 8,
"clients_read": true,
"documentable": "Object",
"participants": [
{
"name": "Gareth Thompson",
"uuid": "1e3cda9b-6fe2-491a-857b-fac7312e2ebd",
"write": true,
"created_at": "2025-08-07T13:41:42+01:00",
"updated_at": "2025-08-07T13:41:42+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
}