Headers

• X-PLANNR-ACCOUNT-UUID string

Path parameters

• circle_uuid string 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.

    Hide participants attributes Show participants attributes object

    • uuid string
    • created_at string
    • updated_at string
    • name string
    • write boolean
  • folders_count integer

    Number of subfolders within the folder

  • folders array[object]

    Subfolders within the folder.

    Hide folders attributes Show folders attributes object

    • uuid string
    • created_at string
    • updated_at string
    • name string
    • slug string
    • path string
    • clients_read boolean
    • clients_write boolean
    • show_client_permissions boolean
    • is_system_folder boolean
    • is_pseudo_folder boolean
    • is_root_folder boolean
    • documentable_type string
    • documentable_uuid string
    • documentable string
    • participants_count integer
    • participants string
    • folders_count integer
    • folders string
    • files_count integer
    • files string
    • parents string
    • ancestors string
    • children string
    • depth integer
    • owned boolean
  • files_count integer

    Number of files stored in the folder

  • files array[object]

    Files stored in the folder.

    Hide files attributes Show files attributes object

    • uuid string
    • created_at string
    • original_created_at string
    • updated_at string
    • uploaded_at string
    • status string
    • filename string
    • name string
    • extension string
    • type string
    • size string
    • path string
    • last_modified string
    • progress string
    • download_url string
    • folder_name string
    • folder string
    • documentable_type string
    • documentable string
    • navigator object
      Hide navigator attributes Show navigator attributes object

      • model_type string
      • model_uuid string
    • firm string
    • account string
    • tags string
  • parents array[object]

    Parent folders.

    Hide parents attributes Show parents attributes object

    • uuid string
    • created_at string
    • updated_at string
    • name string
    • slug string
    • path string
    • clients_read boolean
    • clients_write boolean
    • show_client_permissions boolean
    • is_system_folder boolean
    • is_pseudo_folder boolean
    • is_root_folder boolean
    • documentable_type string
    • documentable_uuid string
    • documentable string
    • participants_count integer
    • participants string
    • folders_count integer
    • folders string
    • files_count integer
    • files string
    • parents string
    • ancestors string
    • children string
    • depth integer
    • owned boolean
  • ancestors array[object]

    All parents folders up the folder heirarchy structure.

    Hide ancestors attributes Show ancestors attributes object

    • uuid string
    • created_at string
    • updated_at string
    • name string
    • slug string
    • path string
    • clients_read boolean
    • clients_write boolean
    • show_client_permissions boolean
    • is_system_folder boolean
    • is_pseudo_folder boolean
    • is_root_folder boolean
    • documentable_type string
    • documentable_uuid string
    • documentable string
    • participants_count integer
    • participants string
    • folders_count integer
    • folders string
    • files_count integer
    • files string
    • parents string
    • ancestors string
    • children string
    • depth integer
    • owned boolean
  • children array[object]

    Subfolders within the folder.

    Hide children attributes Show children attributes object

    • uuid string
    • created_at string
    • updated_at string
    • name string
    • slug string
    • path string
    • clients_read boolean
    • clients_write boolean
    • show_client_permissions boolean
    • is_system_folder boolean
    • is_pseudo_folder boolean
    • is_root_folder boolean
    • documentable_type string
    • documentable_uuid string
    • documentable string
    • participants_count integer
    • participants string
    • folders_count integer
    • folders string
    • files_count integer
    • files string
    • parents string
    • ancestors string
    • children string
    • depth integer
    • owned boolean
  • 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