GET
/api/v1/folder/{uuid}
curl \
-X GET https://api.plannrcrm.com/api/v1/folder/uuid \
-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": "d3e363f7-d1d9-47e4-ad56-c776b99e98c4",
"depth": 5,
"files": [
{
"firm": "App\\Http\\Resources\\FirmResource",
"name": "Welcome to Plannr",
"size": "21691783",
"tags": "App\\Http\\Resources\\TagResource",
"type": "type",
"uuid": "79e70c8a-c1eb-40c3-8387-38a03ea4bba4",
"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/838b5153-566f-40f2-8ceb-6aa3b151e9d2/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": "674db2fe-b88e-4c17-aa24-5989cd13510c",
"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": "43a3fb6c-12c0-4909-a3eb-7643e4c18254",
"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": "53e8f20f-5ac3-460f-8356-cc8749500388",
"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": "80580871-f268-4da5-8ef4-02a9a2bd922e",
"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": "33cfa243-8533-4f6d-9e7c-f7b17ab0c2c6",
"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
}