View deleted files

GET /api/v1/file/bin

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[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'.

  • per_page integer

    Number of results to return with pagination (Default 15. Max 500).

Responses

  • 200 application/json
    Hide response attribute Show response attribute object
    • data array[object]
      Hide data attributes Show data 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 object
        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
      • documentable string
      • navigator object
        Hide navigator attributes Show navigator attributes object
        • model_type string
        • model_uuid string
      • firm object
        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_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_sidebar_account_email string
          • portal_sidebar_divider string
          • portal_dashboard_bg_one string
          • portal_dashboard_bg_two string
          • portal_sidebar_collapse_button string
          • portal_sidebar_collapse_button_hover 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
        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]
        Hide tags attributes Show tags attributes object
        • uuid string
        • created_at string
        • updated_at string
        • name string
        • slug string
        • colour string
GET /api/v1/file/bin
curl \
 --request GET 'https://api.plannrcrm.com/api/v1/file/bin' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200)
{
  "data": [
    {
      "firm": {
        "tax": 17.5,
        "logo": "https://api.plannrcrm.com/images/plannr.jpg",
        "name": "Codepotato",
        "slug": "codepotato",
        "uuid": "dcd960d5-9938-4b2e-a8bc-88a1fffaa06a",
        "county": "Hampshire",
        "billing": {
          "invoice_email": "gareth@codepotato.co.uk",
          "invoice_county": "Hampshire",
          "invoice_country": "United Kingdom",
          "invoice_postcode": "PO7 7YH",
          "invoice_address_1": "Suite E, 5 The Briars",
          "invoice_address_2": "Waterberry Drive",
          "invoice_town_city": "Waterlooville"
        },
        "country": "United Kingdom",
        "postcode": "PO7 7YH",
        "address_1": "Suite E, 5 The Briars",
        "address_2": "Waterberry Drive",
        "logo_icon": "https://api.plannrcrm.com/images/plannr-icon.jpg",
        "month_end": 25,
        "town_city": "Waterlooville",
        "created_at": "2025-08-27T17:31:26+01:00",
        "updated_at": "2025-08-27T17:31:26+01:00",
        "ip_whitelist": [
          "192.168.0.1",
          "127.0.0.1"
        ],
        "brand_colours": {
          "sidebar_text": "#ffffff",
          "sidebar_hover": "#0A0A42",
          "email_sub_text": "#ffffff",
          "sidebar_accent": "#36367E",
          "sidebar_active": "#53DBB8",
          "email_background": "#0E0E56",
          "email_button_text": "#ffffff",
          "portal_background": "#f6f6f6",
          "portal_brand_title": "#323b4b",
          "sidebar_background": "#0E0E56",
          "portal_sidebar_icon": "#828994",
          "portal_sidebar_text": "#323b4b",
          "portal_sidebar_title": "#11151d",
          "sidebar_title_primary": "#FFC634",
          "portal_brand_sub_title": "#828994",
          "portal_sidebar_divider": "#e3e5e9",
          "email_button_background": "#36367E",
          "portal_dashboard_bg_one": "#EF4583",
          "portal_dashboard_bg_two": "#FFC634",
          "sidebar_title_secondary": "#ffffff",
          "sidebar_title_background": "#36367E",
          "portal_sidebar_icon_hover": "#828994",
          "portal_sidebar_text_hover": "#323b4b",
          "portal_sidebar_icon_active": "#828994",
          "portal_sidebar_text_active": "#323b4b",
          "email_logo_background_panel": "#36367E",
          "portal_sidebar_button_hover": "#ffffff",
          "portal_sidebar_account_email": "#828994",
          "portal_sidebar_account_title": "#11151d",
          "portal_sidebar_button_active": "#ffffff",
          "sidebar_title_secondary_hover": "#ffffff",
          "portal_sidebar_collapse_button": "#828994",
          "portal_sidebar_button_background": "#f6f6f6",
          "portal_sidebar_collapse_button_hover": "#B3B9C4"
        },
        "is_subscribed": true,
        "regulatory_text": "Regulatory text",
        "addon_subscriptions": "App\\Http\\Resources\\Addons\\AddonSubscriptionResource",
        "statement_frequency": "monthly",
        "task_board_template": "App\\Http\\Resources\\Board\\BoardResource",
        "keep_deleted_files_for": 30,
        "welcome_paragraph_html": "<h1>Welcome.</h1>",
        "email_welcome_paragraph_html": "Welcome to Plannr!",
        "show_fact_find_illustrations": true
      },
      "name": "Welcome to Plannr",
      "path": "Gareth Thompson/Subfolder/Welcome to Plannr.pdf",
      "size": "21691783",
      "tags": [
        {
          "name": "Mortgage",
          "slug": "mortgage",
          "uuid": "5e3b8adf-188c-4004-8f03-9c4a4f7f048d",
          "colour": "#ef4582",
          "created_at": "2025-08-27T17:31:26+01:00",
          "updated_at": "2025-08-27T17:31:26+01:00"
        }
      ],
      "type": "type",
      "uuid": "111734f1-127c-4603-9ada-d338d18fc4cc",
      "folder": {
        "name": "Important Documents",
        "path": "Codepotato/Important Documents",
        "slug": "important-documents",
        "uuid": "d1d16220-e6da-4012-9c6e-7f93c9d2aa44",
        "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-08-27T17:31:26+01:00",
        "updated_at": "2025-08-27T17:31:26+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
      },
      "status": "uploaded",
      "account": {
        "name": "Gareth Thompson",
        "role": "client",
        "type": "client",
        "uuid": "98872fa5-d785-40d0-869a-2a310a963dd2",
        "email": "gareth@codepotato.co.uk",
        "last_name": "Thompson",
        "photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
        "created_at": "2025-08-27T17:31:26+01:00",
        "first_name": "Gareth",
        "updated_at": "2025-08-27T17:31:26+01:00",
        "external_references": "App\\Http\\Resources\\ExternalReferenceResource"
      },
      "filename": "Welcome to Plannr.pdf",
      "progress": "100",
      "extension": "pdf",
      "navigator": {
        "model_type": "account",
        "model_uuid": "0d9631ae-dbb4-4693-9bad-47cbb798a4d1"
      },
      "created_at": "2025-08-27T17:31:26+01:00",
      "updated_at": "2025-08-27T17:31:26+01:00",
      "folder_name": "folder 2",
      "uploaded_at": "2025-08-27T17:31:26+01:00",
      "documentable": "Object",
      "download_url": "https://api.plannrcrm.com/file/990aeda5-9fee-4801-91e1-0d4f035cbab6/download",
      "last_modified": "2025-08-27T17:31:26+01:00",
      "documentable_type": "account",
      "original_created_at": "2025-08-27T17:31:26+01:00"
    }
  ]
}