Path parameters

• model string Required
• modelUuid string Required

Query parameters

• include string

  Comma separated list of relationships to include in the response. Valid relationships are [documentable, folder, account, tags].

• filter[uuid] string

  Filter by a comma separated list of UUIDs.

• filter[name] string

  File name to filter by.

• filter[date_from] string

  File uploaded_at date to filter from a specific date, can be used with date_to for a range.

• filter[date_to] string

  File uploaded_at date to filter to a specific date, can be used with date_from for a range.

• filter[extension] string

  File extension to filter by.

• filter[uploaded_by_uuid] string

  Filter by a comma separated list of account UUIDs of who uploaded the file.

• filter[uploaded_by] integer

  [DEPRECATED] Use uploaded_by_uuid instead. The account the uploaded the file to filter by. Takes a UUID.

• filter[size] string

  The size of the file to filter by. Can take two values to filter in a range or one value to get files lesser than or equal to value. Unit of file size is in kilobytes.

• filter[last_modified_from] string

  File last_modified date to filter to from a specific date, can be used with last_modified_to for a range.

• filter[last_modified_to] string

  File last_modified date to filter to a specific date, can be used with last_modified_from for a range.

• filter[original_created_from] string

  File original_created_at date to filter from a specific date, can be used with original_created_to for a range.

• filter[original_created_to] string

  File original_created_at date to filter to a specific date, can be used with original_created_from for a range.

• sort string

  Field to sort by. Valid fields are [uploaded_at, created_at, updated_at, name]. Negative sign to denote DESC. Defaults to 'name'.

Responses

• 200 application/json
  Hide response attributes Show response attributes object

  • uuid string

    UUID of the file

  • created_at string

    The timestamp of when the resource was created.

  • original_created_at string

    Timestamp of when the file was originally created

  • updated_at string

    The timestamp of when the resource was updated.

  • uploaded_at string

    Timestamp of when the file was uploaded

  • status string

    Current status of the uploading progress

  • filename string

    The filename including extension

  • name string

    The name of the file without extension

  • extension string

    The extension of the file

  • type string

    The MIME type of the file

  • size string

    The size of the file in bytes

  • path string

    The path of the file

  • last_modified string

    Timestamp of when the file was last modified before uploading

  • progress string

    The progress of the uploaded file as a percentage between 0 and 100

  • download_url string

    The download URL of the file

  • folder_name string

    The name of the folder the file is located in

  • folder object

    The folder this file is located in

    Hide folder attributes Show folder 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
  • documentable_type string

    The documentable type such as account/plan/case/etc the file was uploaded to

  • documentable string

    The documentable the file was uploaded to

  • navigator object

    The documentable type and its UUID in order to navigator to the correct resource

    Hide navigator attributes Show navigator attributes object

    • model_type string
    • model_uuid string
  • firm object

    The firm which the file belongs to

    Hide firm attributes Show firm attributes object

    • uuid string
    • created_at string
    • updated_at string
    • name string
    • slug string
    • address_1 string
    • address_2 string
    • town_city string
    • county string
    • postcode string
    • country string
    • regulatory_text string
    • logo string
    • logo_icon string
    • brand_colours object
      Hide brand_colours attributes Show brand_colours attributes object

      • sidebar_background string
      • sidebar_accent string
      • sidebar_text string
      • sidebar_hover string
      • sidebar_active string
      • sidebar_title_background string
      • sidebar_title_primary string
      • sidebar_title_secondary string
      • sidebar_title_secondary_hover string
      • email_background string
      • email_logo_background_panel string
      • email_sub_text string
      • email_button_background string
      • email_button_text string
      • portal_sidebar_button_background string
      • portal_sidebar_button_hover string
      • portal_sidebar_button_active string
      • portal_brand_title string
      • portal_brand_sub_title string
      • portal_sidebar_title string
      • portal_sidebar_text string
      • portal_sidebar_text_hover string
      • portal_sidebar_text_active string
      • portal_sidebar_icon string
      • portal_sidebar_icon_hover string
      • portal_sidebar_icon_active string
      • portal_background string
      • portal_sidebar_account_title string
      • portal_account_email string
      • portal_sidebar_divider string
      • portal_dashboard_bg_one string
      • portal_dashboard_bg_two string
    • is_subscribed boolean
    • addon_subscriptions string
    • keep_deleted_files_for integer
    • tax number
    • month_end integer
    • statement_frequency string
    • billing object
      Hide billing attributes Show billing attributes object

      • invoice_address_1 string
      • invoice_address_2 string
      • invoice_town_city string
      • invoice_county string
      • invoice_postcode string
      • invoice_country string
      • invoice_email string
    • task_board_template string
    • ip_whitelist array[string]
    • welcome_paragraph_html string
    • email_welcome_paragraph_html string
    • show_fact_find_illustrations boolean
  • account object

    The account that uploaded the file (if specified)

    Hide account attributes Show account attributes object

    • uuid string
    • created_at string
    • updated_at string
    • type string
    • role string
    • first_name string
    • last_name string
    • name string
    • email string
    • photo_url string
    • external_references string
  • tags array[object]

    The tags added to the file (if provided)

    Hide tags attributes Show tags attributes object

    • uuid string
    • created_at string
    • updated_at string
    • name string
    • slug string
    • colour string