Headers
-
Content-Type
string -
Accept
string
Path parameters
-
folder_uuid
integer 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[include_subfolders]
boolean Denotes whether to include files from the requested folders recurisve sub folders if the account can view them.
-
filter[folder_uuid]
string Filter by a comma separated list of folder UUIDs that belong to the folder in the URL.
-
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.
-
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'.
curl \
--request GET 'https://api.plannrcrm.com/api/v1/folder/folder_uuid/files' \
--header "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"{
"firm": {
"tax": 17.5,
"logo": "https://api.plannrcrm.com/images/plannr.jpg",
"name": "Codepotato",
"slug": "codepotato",
"uuid": "b560346b-6796-4b3d-8a8e-7d2fe4220d1d",
"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-04-22T13:44:19+01:00",
"updated_at": "2025-04-22T13:44:19+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",
"sidebar_background": "#0E0E56",
"sidebar_title_primary": "#FFC634",
"email_button_background": "#36367E",
"sidebar_title_secondary": "#ffffff",
"sidebar_title_background": "#36367E",
"email_logo_background_panel": "#36367E",
"sidebar_title_secondary_hover": "#ffffff"
},
"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": "7278469b-dc88-4d85-ad72-0378bd5f2e39",
"colour": "#ef4582",
"created_at": "2025-04-22T13:44:19+01:00",
"updated_at": "2025-04-22T13:44:19+01:00"
}
],
"type": "type",
"uuid": "13b653d8-fbdd-44fa-aec3-f92c879b6125",
"folder": {
"name": "Important Documents",
"path": "Codepotato/Important Documents",
"slug": "important-documents",
"uuid": "1120e9ac-df07-4750-b735-b48ed1e2a203",
"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-04-22T13:44:19+01:00",
"updated_at": "2025-04-22T13:44:19+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": "68a25781-197a-4c53-8e82-84932e112778",
"email": "gareth@codepotato.co.uk",
"last_name": "Thompson",
"photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
"created_at": "2025-04-22T13:44:19+01:00",
"first_name": "Gareth",
"updated_at": "2025-04-22T13:44:19+01:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource"
},
"filename": "Welcome to Plannr.pdf",
"progress": "100",
"extension": "pdf",
"navigator": {
"model_type": "account",
"model_uuid": "0956dc82-3a96-4d49-909f-49e960a1bd18"
},
"created_at": "2025-04-22T13:44:19+01:00",
"updated_at": "2025-04-22T13:44:19+01:00",
"folder_name": "folder 2",
"uploaded_at": "2025-04-22T13:44:19+01:00",
"documentable": "Object",
"download_url": "https://plannr.valet/file/ac06b942-c68b-453b-83d5-1a580413056c/download",
"last_modified": "2025-04-22T13:44:19+01:00",
"documentable_type": "account",
"original_created_at": "2025-04-22T13:44:19+01:00"
}