Get root folder for a firm

GET /api/v1/firm/{firm_uuid}/documents

Personal access token & OAuth2

Headers

Authorization string
Content-Type string
Accept string

Path parameters

firm_uuid integer Required

Responses

200 application/json
Hide response attributes Show response attributes object
- uuid string
  
  The UUID of the resource.
- created_at string
  
  The timestamp of when the resource was created.
- updated_at string
  
  The timestamp of when the resource was updated.
- name string
  
  Folder name
- slug string
  
  Slug of the folder name
- path string
  
  Folder path
- clients_read boolean
  
  Denotes whether clients can access this folder and files
- clients_write boolean
  
  Denotes whether clients can upload files to this folder
- show_client_permissions boolean
  
  Denotes whether the option to change client permissions is enabled which depends on the firm show pseudo folders in client portal setting
- is_system_folder boolean
  
  Denotes if this folder is a system folder
- is_pseudo_folder boolean
  
  Denotes if this folder is a pseudo folder
- is_root_folder boolean
  
  Denotes if this folder is a root folder of a documentable item
- documentable_type string
  
  The documentable type such as account/plan/case/etc the file was uploaded to
- documentable_uuid string
  
  The UUID of the documentable resource
- documentable string
  
  The documentable the file was uploaded to
- participants_count integer
  
  Number of accounts this folder has been directly shared with
- participants array[object]
  
  Participants whom this folder has been directly shared with.
  
  Additional properties are allowed.
- folders_count integer
  
  Number of subfolders within the folder
- folders array[object]
  
  Subfolders within the folder.
  
  Additional properties are allowed.
- files_count integer
  
  Number of files stored in the folder
- files array[object]
  
  Files stored in the folder.
  
  Additional properties are allowed.
- parents array[object]
  
  Parent folders.
  
  Additional properties are allowed.
- ancestors array[object]
  
  All parents folders up the folder heirarchy structure.
  
  Additional properties are allowed.
- children array[object]
  
  Subfolders within the folder.
  
  Additional properties are allowed.
- depth integer
  
  How many levels deep there are to this folder heirarchy structure
- owned boolean
  
  Is true if the authenticated account in the request has created this folder

GET /api/v1/firm/{firm_uuid}/documents

curl \
 --request GET https://api.plannrcrm.com/api/v1/firm/firm_uuid/documents \
 --header "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 --header "Content-Type: application/json" \
 --header "Accept: application/json"

Response examples (200)

{
  "name": "Important Documents",
  "path": "Codepotato/Important Documents",
  "slug": "important-documents",
  "uuid": "5f2ab65b-a7be-4edf-94b7-c8e72d87cc0a",
  "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": "b08962d4-9c30-4584-ae2b-4ba33736f57b",
      "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": "8da947ba-5641-4be1-835e-25dcd34baf3b"
      },
      "created_at": "2025-02-20T10:13:00+00:00",
      "updated_at": "2025-02-20T10:13:00+00:00",
      "folder_name": "folder 2",
      "uploaded_at": "2025-02-20T10:13:00+00:00",
      "documentable": "Object",
      "download_url": "https://plannr.valet/file/d2697896-02f3-46f1-a04e-528fb22ff06b/download",
      "last_modified": "2025-02-20T10:13:00+00:00",
      "documentable_type": "account",
      "original_created_at": "2025-02-20T10:13:00+00:00"
    }
  ],
  "owned": false,
  "folders": [
    {
      "name": "Important Documents",
      "path": "Codepotato/Important Documents",
      "slug": "important-documents",
      "uuid": "2d9734c0-a821-4f80-ae80-d3914ea0cba5",
      "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-02-20T10:13:00+00:00",
      "updated_at": "2025-02-20T10:13:00+00: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": "b57c965b-3abe-4d08-bd64-0afb3eca91ac",
      "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-02-20T10:13:00+00:00",
      "updated_at": "2025-02-20T10:13:00+00: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": "2215cc28-1cf3-41fa-a52c-d971b4b6c6e0",
      "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-02-20T10:13:00+00:00",
      "updated_at": "2025-02-20T10:13:00+00: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": "b76f1dd5-0d7e-47ed-82eb-542d64458a6c",
      "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-02-20T10:13:00+00:00",
      "updated_at": "2025-02-20T10:13:00+00: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-02-20T10:13:00+00:00",
  "updated_at": "2025-02-20T10:13:00+00:00",
  "files_count": 8,
  "clients_read": true,
  "documentable": "Object",
  "participants": [
    {
      "name": "Gareth Thompson",
      "uuid": "4703d668-e58b-4534-9ef8-c40acbd1d758",
      "write": true,
      "created_at": "2025-02-20T10:13:00+00:00",
      "updated_at": "2025-02-20T10:13:00+00: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
}