Headers
-
Content-Type string
-
Accept string
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": "7188b0f1-26d2-4095-bbc8-73935aebb220",
"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-02-20T10:13:03+00:00",
"updated_at": "2025-02-20T10:13:03+00: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!"
},
"name": "Welcome to Plannr",
"path": "Gareth Thompson/Subfolder/Welcome to Plannr.pdf",
"size": "21691783",
"tags": [
{
"name": "Mortgage",
"slug": "mortgage",
"uuid": "9fee0b6d-3853-4739-ac3f-c805736c33a2",
"colour": "#ef4582",
"created_at": "2025-02-20T10:13:03+00:00",
"updated_at": "2025-02-20T10:13:03+00:00"
}
],
"type": "type",
"uuid": "67f51b15-9f4a-41d3-9f4b-6f19973af179",
"folder": {
"name": "Important Documents",
"path": "Codepotato/Important Documents",
"slug": "important-documents",
"uuid": "83ed52d9-99f9-4078-8eb7-57a5b58c50cd",
"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-02-20T10:13:03+00:00",
"updated_at": "2025-02-20T10:13:03+00: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": "6afb5011-5812-456c-b28f-21a0ef71169b",
"email": "gareth@codepotato.co.uk",
"last_name": "Thompson",
"photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
"created_at": "2025-02-20T10:13:03+00:00",
"first_name": "Gareth",
"updated_at": "2025-02-20T10:13:03+00:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource"
},
"filename": "Welcome to Plannr.pdf",
"progress": "100",
"extension": "pdf",
"navigator": {
"model_type": "account",
"model_uuid": "4fd1ba0b-1b41-4b17-b75c-271ae1d6d908"
},
"created_at": "2025-02-20T10:13:03+00:00",
"updated_at": "2025-02-20T10:13:03+00:00",
"folder_name": "folder 2",
"uploaded_at": "2025-02-20T10:13:03+00:00",
"documentable": "Object",
"download_url": "https://plannr.valet/file/fa90f511-590a-4501-bacb-837e3cdaba5a/download",
"last_modified": "2025-02-20T10:13:03+00:00",
"documentable_type": "account",
"original_created_at": "2025-02-20T10:13:03+00:00"
}