Get root folder for a case
Headers
-
Content-Type string
-
Accept string
-
X-PLANNR-ACCOUNT-UUID string
GET
/api/v1/cases/{case_uuid}/documents
curl \
-X GET https://api.plannrcrm.com/api/v1/cases/case_uuid/documents \
-H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"
Response examples (200)
{
"name": "Important Documents",
"path": "Codepotato/Important Documents",
"slug": "important-documents",
"uuid": "7fdf7b90-9ea2-492c-9902-efd129c41b8e",
"depth": 5,
"files": [
{
"firm": "App\\Http\\Resources\\FirmResource",
"name": "Welcome to Plannr",
"size": "21691783",
"tags": "App\\Http\\Resources\\TagResource",
"type": "type",
"uuid": "4a0fc667-9d10-4ec3-ac28-f6462abef0f7",
"parent": "Object",
"status": "uploaded",
"account": "App\\Http\\Resources\\AccountResource",
"filename": "Welcome to Plannr.pdf",
"progress": "100",
"extension": "pdf",
"created_at": "2025-01-21T09:11:09+00:00",
"updated_at": "2025-01-21T09:11:09+00:00",
"folder_name": "folder 2",
"uploaded_at": "2025-01-21T09:11:09+00:00",
"download_url": "https://plannr.valet/file/cd9bdb8e-071e-49a1-94c2-eb6337285143/download",
"last_modified": "2025-01-21T09:11:09+00:00",
"original_created_at": "2025-01-21T09:11:09+00:00"
}
],
"owned": false,
"folders": [
{
"name": "Important Documents",
"path": "Codepotato/Important Documents",
"slug": "important-documents",
"uuid": "de11dcdd-1298-4b3e-96f5-af06465b8891",
"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-21T09:11:09+00:00",
"updated_at": "2025-01-21T09:11:09+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": "57661a04-cedd-42cf-9b14-36cb287f4f23",
"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-21T09:11:09+00:00",
"updated_at": "2025-01-21T09:11:09+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": "70eaaa2b-1c6f-4bcc-978b-d23d69294236",
"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-21T09:11:09+00:00",
"updated_at": "2025-01-21T09:11:09+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": "502e8cb8-b3b4-44e6-8865-d3cdeb5db04b",
"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-21T09:11:09+00:00",
"updated_at": "2025-01-21T09:11:09+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-21T09:11:09+00:00",
"updated_at": "2025-01-21T09:11:09+00:00",
"files_count": 8,
"clients_read": true,
"participants": [
{
"name": "Gareth Thompson",
"uuid": "cba82773-39ec-40a6-b286-b87004d9e061",
"write": true,
"created_at": "2025-01-21T09:11:09+00:00",
"updated_at": "2025-01-21T09:11:09+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
}