# Get all files on a documentable model

**GET /api/v1/files/{model}/{modelUuid}**

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.


## Servers
- https://api.plannrcrm.com: https://api.plannrcrm.com ()


## Authentication methods
- Personal access token & O auth2


## Parameters

### Path parameters
- **model** (string)

- **modelUuid** (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[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


#### Body: application/json (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
- **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
- **firm** (object)
  The firm which the file belongs to
- **account** (object)
  The account that uploaded the file (if specified)
- **tags** (array[object])
  The tags added to the file (if provided)


[Powered by Bump.sh](https://bump.sh)