Get a folder

GET /api/v1/folder/{uuid}
Personal access token & O auth2

Path parameters

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.

    • folders_count integer

      Number of subfolders within the folder

    • folders array[object]

      Subfolders within the folder.

    • files_count integer

      Number of files stored in the folder

    • files array[object]

      Files stored in the folder.

    • parents array[object]

      Parent folders.

    • ancestors array[object]

      All parents folders up the folder heirarchy structure.

    • children array[object]

      Subfolders within the folder.

    • 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/folder/{uuid} 
curl \
 --request GET 'https://api.plannrcrm.com/api/v1/folder/uuid' \
 --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": "1a5e3934-5353-4865-b7b6-dd2490487a14",
  "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": "12769b1a-44a2-4d50-824c-e0cb847050b6",
      "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": "bb06fc2a-39a3-4391-b0c4-80ec5d274d6a"
      },
      "created_at": "2025-05-14T18:27:13+01:00",
      "updated_at": "2025-05-14T18:27:13+01:00",
      "folder_name": "folder 2",
      "uploaded_at": "2025-05-14T18:27:13+01:00",
      "documentable": "Object",
      "download_url": "https://plannr.valet/file/97576cde-ef15-4617-a09a-e03490f1d548/download",
      "last_modified": "2025-05-14T18:27:13+01:00",
      "documentable_type": "account",
      "original_created_at": "2025-05-14T18:27:13+01:00"
    }
  ],
  "owned": false,
  "folders": [
    {
      "name": "Important Documents",
      "path": "Codepotato/Important Documents",
      "slug": "important-documents",
      "uuid": "72bc2789-05ea-4e46-86ce-54ecbc6cf7e6",
      "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-05-14T18:27:13+01:00",
      "updated_at": "2025-05-14T18:27:13+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": "cfc5404d-4908-44e2-aef5-a72b52c3d77e",
      "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-05-14T18:27:13+01:00",
      "updated_at": "2025-05-14T18:27:13+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": "4e03cb71-ef3e-46d1-be1d-6052c81619c2",
      "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-05-14T18:27:13+01:00",
      "updated_at": "2025-05-14T18:27:13+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": "cb79a8e7-eb9f-4ec7-9223-e893b3b262de",
      "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-05-14T18:27:13+01:00",
      "updated_at": "2025-05-14T18:27:13+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-05-14T18:27:13+01:00",
  "updated_at": "2025-05-14T18:27:13+01:00",
  "files_count": 8,
  "clients_read": true,
  "documentable": "Object",
  "participants": [
    {
      "name": "Gareth Thompson",
      "uuid": "b0fa1a0e-be5b-47f5-8730-cd9de565808a",
      "write": true,
      "created_at": "2025-05-14T18:27:13+01:00",
      "updated_at": "2025-05-14T18:27:13+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
}