Headers
-
Content-Type
string -
Accept
string -
X-PLANNR-ACCOUNT-UUID
string
Path parameters
-
plan_uuid
string Required
GET
/api/v1/plans/{plan_uuid}/documents
curl \
--request GET 'https://api.plannrcrm.com/api/v1/plans/plan_uuid/documents' \
--header "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"
Response examples (200)
{
"name": "Important Documents",
"path": "Codepotato/Important Documents",
"slug": "important-documents",
"uuid": "da3a6743-ee56-4a34-a3fd-d7b4a8fc1c70",
"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": "452832bd-6fb9-4a61-ba3b-05c53f4e7e83",
"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": "2e79fbaf-e0a8-48c9-8e12-dc0825ee5326"
},
"created_at": "2025-04-02T13:27:57+01:00",
"updated_at": "2025-04-02T13:27:57+01:00",
"folder_name": "folder 2",
"uploaded_at": "2025-04-02T13:27:57+01:00",
"documentable": "Object",
"download_url": "https://plannr.valet/file/633cbf43-e79f-415b-af77-ba7523059e5a/download",
"last_modified": "2025-04-02T13:27:57+01:00",
"documentable_type": "account",
"original_created_at": "2025-04-02T13:27:57+01:00"
}
],
"owned": false,
"folders": [
{
"name": "Important Documents",
"path": "Codepotato/Important Documents",
"slug": "important-documents",
"uuid": "f3770b72-52b5-408b-b9ac-8a88813bb96a",
"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-04-02T13:27:57+01:00",
"updated_at": "2025-04-02T13:27:57+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": "b5f41a55-3e14-477f-a9ee-3736c9931de9",
"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-04-02T13:27:57+01:00",
"updated_at": "2025-04-02T13:27:57+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": "2f7ac7f3-c382-41c5-a87d-0ec0fa21b5eb",
"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-04-02T13:27:57+01:00",
"updated_at": "2025-04-02T13:27:57+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": "1073a142-473c-408f-a659-80af6725775b",
"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-04-02T13:27:57+01:00",
"updated_at": "2025-04-02T13:27:57+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-04-02T13:27:57+01:00",
"updated_at": "2025-04-02T13:27:57+01:00",
"files_count": 8,
"clients_read": true,
"documentable": "Object",
"participants": [
{
"name": "Gareth Thompson",
"uuid": "63a873b4-9679-4823-8a2a-3c52fa97b48f",
"write": true,
"created_at": "2025-04-02T13:27:57+01:00",
"updated_at": "2025-04-02T13:27:57+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
}