Get all files on a documentable model
Provide a documentable model as a string ('account', 'case', 'firm', or 'plan') and the UUID for the model. This index will get all files within the folder tree starting from the root folder of the provided model.
Headers
-
Content-Type string
-
Accept string
Query parameters
-
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] integer
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.
-
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, updated_at, name]. Negative sign to denote DESC. Defaults to 'name'.
curl \
-X GET https://api.plannrcrm.com/api/v1/files/model/modelUuid \
-H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
-H "Content-Type: application/json" \
-H "Accept: application/json"{
"firm": {
"tax": 17.5,
"logo": "https://api.plannrcrm.com/images/plannr.jpg",
"name": "Codepotato",
"slug": "codepotato",
"uuid": "afa1af90-59be-4047-9496-ee7c75fbada7",
"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": "2024-11-20T13:24:02+00:00",
"updated_at": "2024-11-20T13:24:02+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",
"size": "21691783",
"tags": [
{
"name": "Mortgage",
"slug": "mortgage",
"uuid": "f3738bd0-314b-4f62-af7e-ba774de07a80",
"colour": "#ef4582",
"created_at": "2024-11-20T13:24:02+00:00",
"updated_at": "2024-11-20T13:24:02+00:00"
}
],
"type": "type",
"uuid": "b6e91b6f-8283-4089-8aaf-0cd1c8fd91db",
"parent": "Object",
"status": "uploaded",
"account": {
"firm": "App\\Http\\Resources\\FirmResource",
"name": "Gareth Thompson",
"role": "client",
"tags": "App\\Http\\Resources\\TagResource",
"type": "client",
"uuid": "4b7f1e67-2946-462a-b21d-e3b3bd1f02a5",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"last_name": "Thompson",
"created_at": "2024-11-20T13:24:02+00:00",
"first_name": "Gareth",
"updated_at": "2024-11-20T13:24:02+00:00",
"with_login": true,
"custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
"introduced_by": "App\\Http\\Resources\\AccountResource",
"primary_email": "App\\Http\\Resources\\ContactDetailResource",
"can_be_deleted": "false",
"assigned_adviser": "App\\Http\\Resources\\AccountResource",
"next_review_date": "2024-11-20T13:24:02+00:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2024-11-20T13:24:02+00:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"previous_review_date": "2024-11-20T13:24:02+00:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2024-11-20T13:24:02+00:00"
},
"filename": "Welcome to Plannr.pdf",
"progress": "100",
"extension": "pdf",
"created_at": "2024-11-20T13:24:02+00:00",
"updated_at": "2024-11-20T13:24:02+00:00",
"folder_name": "folder 2",
"uploaded_at": "2024-11-20T13:24:02+00:00",
"download_url": "https://plannr.valet/file/850ccaea-a7f2-4d10-bbe0-073deb8b08ec/download",
"last_modified": "2024-11-20T13:24:02+00:00",
"original_created_at": "2024-11-20T13:24:02+00:00"
}