Files
A file stored in the organization with public or private access.
- API name:
files - Domain: Features
- Modules: Sales analytics, Finance analytics, Inventory analytics, Manufacturing analytics, Purchasing analytics, Sales, Stores, Services, Finances, Inventory, Manufacturing, Purchasing, Logistics, Human resources, Employee portal, Point of sale, Site operations, My workspace, Master data, Directory, Administration
Fields
The API name is what the API, MCP and the CLI use.
| Name | API name | Type | Required | Description |
|---|---|---|---|---|
| ID | id | Record ID | Yes | |
| File name | filename | Text | Yes | |
| Content type | contentType | Text | ||
| Size | size | Whole Number | Yes | File size in bytes. |
| File kind | type | Constant | Fixed option from the allowed set for this field. | |
| Created by | createdBy | User | ||
| Created at | createdAt | Date and Time | Yes | |
| Updated by | updatedBy | User | ||
| Updated at | updatedAt | Date and Time | Yes | |
| Blocked by | blockedBy | User | ||
| Blocked at | blockedAt | Date and Time | ||
| Archived by | archivedBy | User | ||
| Archived at | archivedAt | Date and Time |
Actions
What you can do with a record. Every action also sends the webhook event files.<action>. Reads (find, get, count) work on every table.
| Name | API name | Description | Where |
|---|---|---|---|
| Edit | update | Save changes to this file. | App · API · MCP · CLI |
| Block | block | Stop edits and deletion of this file. It stays visible and can still appear on existing documents. Unblock to edit again. | App · API · MCP · CLI |
| Unblock | unblock | Allow edits and deletion of this file again. | App · API · MCP · CLI |
| Archive | archive | Retire this file from daily use. It leaves active lists and pickers, and most actions stop. Unarchive to restore it. | App · API · MCP · CLI |
| Restore | unarchive | Return this file to active lists and actions. | App · API · MCP · CLI |
| Delete | delete | Delete this file and the data that belongs with it. This cannot be undone. | App · API · MCP · CLI |