File data model
View field support, webhooks, and list parameters for each integration on the Supported Integrations page.
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | |
created_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
updated_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
name | string | No | |
description | string | No | |
parent_id | string | No | |
user_id | string | No | (reference to HrisEmployee) |
size | number | No | |
type | enum | No | Values: FILE, FOLDER |
mime_type | string | No | |
permissions | StoragePermission[] | No | |
permissions[].user_id | string | No | (reference to HrisEmployee) |
permissions[].group_id | string | No | (reference to HrisGroup) |
permissions[].roles | enum[] | Yes | Values: OWNER, READ, WRITE |
permissions[].is_hidden | boolean | No | |
permissions[].is_public | boolean | No | |
download_url | string | No | This link expires after 1 hour. When you need to retrieve the contents of a file, call the "Retrieve a file" endpoint again to get a new download_url. |
hash | string | No | |
data | string | No | base64 encoded file contents used to create/update only |
version | string | No | |
web_url | string | No | |
references | StorageReference[] | No | |
references[].id | string | No | |
references[].type | string | No | |
references[].name | string | No | |
tags | string[] | No | labels |
Are we missing anything? Let us know