files_list
Retrieve paginated lists of files filtered by associated entities like deals, persons, or organizations, with sorting and pagination options.
Instructions
List files with pagination and filtering options.
Returns a paginated list of files. Use filters to narrow results by associated entity (deal, person, organization, activity, product).
Workflow tips:
Filter by entity to get files for specific deals, persons, organizations, etc.
Use sort to order by add_time, update_time, file_name, or file_size
Set include_deleted_files=true to see deleted files
Use start/limit for pagination (default limit: 100, max: 500)
Combine multiple filters to narrow results
Common use cases:
List all files for a deal: { "deal_id": 123 }
List all files for a person: { "person_id": 456 }
List all files for an organization: { "org_id": 789 }
List recent files sorted by upload time: { "sort": "add_time", "sort_by": "desc" }
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| deal_id | No | Filter by deal ID | |
| person_id | No | Filter by person ID | |
| org_id | No | Filter by organization ID | |
| activity_id | No | Filter by activity ID | |
| product_id | No | Filter by product ID | |
| include_deleted_files | No | Whether to include deleted files (default: false) | |
| sort | No | Field to sort by (e.g., add_time, update_time, file_name, file_size) | |
| sort_by | No | Sort direction | |
| start | No | Pagination start | |
| limit | No | Number of items to return |