Types

Document

A document: a file kept in a folder, with who may read and write it.

idrequired
string (uuid)
The document's id.
namerequired
string
The document's name, unique among the live documents in its folder.
folder_idrequired
string | null (uuid)
The folder the document is in.
deal_idrequired
string | null (uuid)
The deal whose folder tree holds this document, or null when it is not in a deal's tree.
typerequired
string
The kind of file, worked out from its content type.One of: binary, image, video, text, csv, doc, sheet, presentation, pdf, file, email
statusrequired
string
Where the file is in processing. Only a file_available document can be downloaded; not_validated, not_scanned and watermark_processing are still in progress, failed_scan failed its virus scan, and video_processed is a transcoded video.One of: not_validated, not_scanned, failed_scan, file_available, video_processed, watermark_processing
mime_typerequired
string | null
The content type of the file. Null for a video, which has no file.
sizerequired
integer | null
The size of the file in bytes. Null for a video, which has no file.
descriptionrequired
string | null
A note kept with the document.
metadatarequired
object | null
Free-form key-value data kept with the document.
owner_idrequired
string | null (uuid)
The user who added the document.
allow_downloadrequired
boolean | null
Whether people may download the document. Null follows the organisation's document settings.
apply_watermarkrequired
boolean | null
Whether downloads are watermarked. Null follows the organisation's document settings.
maskedrequired
boolean
Whether the document was produced from a form template with some of its content masked.
accessrequired
object
Groups of users who may read and write the document without being listed in its permissions.
permissions
object
Who may read and write the document, including what it inherits from its folder.
created_atrequired
string (date-time)
When the document was added.
updated_atrequired
string (date-time)
When the document last changed.

Used by (8)