Get root folder for a circle

GET /api/v1/circles/{circle_uuid}/documents

Personal access token & O auth2

Headers

Path parameters

circle_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.
- 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/circles/{circle_uuid}/documents

curl \
 --request GET 'https://api.plannrcrm.com/api/v1/circles/circle_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": "aaf24949-17b5-4b8f-95d7-f92026c5c14e",
  "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": "5aad7a7a-6798-42a2-8bdb-842e84aff127",
      "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": "359690bb-53e1-4c02-9df6-e8bf8ba262eb"
      },
      "created_at": "2025-05-21T13:38:00+01:00",
      "updated_at": "2025-05-21T13:38:00+01:00",
      "folder_name": "folder 2",
      "uploaded_at": "2025-05-21T13:38:00+01:00",
      "documentable": "Object",
      "download_url": "https://plannr.valet/file/f3880c74-d791-410e-8354-baf9f4e5047a/download",
      "last_modified": "2025-05-21T13:38:00+01:00",
      "documentable_type": "account",
      "original_created_at": "2025-05-21T13:38:00+01:00"
    }
  ],
  "owned": false,
  "folders": [
    {
      "name": "Important Documents",
      "path": "Codepotato/Important Documents",
      "slug": "important-documents",
      "uuid": "f4438d5d-5bc4-4a72-bb82-7ceb6e26f4f8",
      "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-21T13:38:00+01:00",
      "updated_at": "2025-05-21T13:38:00+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": "60ae0fbe-b275-477c-a579-02a57075e323",
      "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-21T13:38:00+01:00",
      "updated_at": "2025-05-21T13:38:00+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": "345db325-1588-4aa1-b76d-856886b468a0",
      "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-21T13:38:00+01:00",
      "updated_at": "2025-05-21T13:38:00+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": "57a8b3a3-d6c9-48d6-8ad0-8a7b7f837f5a",
      "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-21T13:38:00+01:00",
      "updated_at": "2025-05-21T13:38:00+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-21T13:38:00+01:00",
  "updated_at": "2025-05-21T13:38:00+01:00",
  "files_count": 8,
  "clients_read": true,
  "documentable": "Object",
  "participants": [
    {
      "name": "Gareth Thompson",
      "uuid": "7b6fef09-f97f-422f-ab35-7ccee5a5b003",
      "write": true,
      "created_at": "2025-05-21T13:38:00+01:00",
      "updated_at": "2025-05-21T13:38:00+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
}