File
Files are used to upload documents via presigned URLs. After uploading and completing a file, link it to resources through their own APIs (e.g. attach a transcript to a meeting). See File uploads for the full upload flow and supported purposes. For meeting transcript attachments, see Uploading meeting transcripts. Not every retrievable file is listable: files uploaded through the app and synced chat attachments are fetchable by id (GET /v1/files/{id}, GET /v1/files/{id}/url, or a CRM record’s $files relationship) but never appear in GET /v1/files.
Create a file upload session
Import a file from Google Drive, OneDrive or SharePoint
Complete a file upload
Cancel a file upload
ModelsExpand Collapse
class FileCancelResponse: …
When the upload session expires. Null once completed, cancelled, or expired.
kind: Optional[Literal["file", "folder"]]Whether the item is a file or a folder. Null when the response was built without that column.
Whether the item is a file or a folder. Null when the response was built without that column.
When the storage last modified this item. Null for a non-storage file, and for a storage item whose modified time has not been stored.
The storage folder this item sits in, or null for a top-level item or a non-storage file.
source: Optional[Literal["googleDrive", "microsoftDrive"]]Where the file came from. googleDrive for a linked Google Drive item, microsoftDrive for a linked OneDrive or SharePoint item. Null for every other file.
Where the file came from. googleDrive for a linked Google Drive item, microsoftDrive for a linked OneDrive or SharePoint item. Null for every other file.
class FileCompleteResponse: …
When the upload session expires. Null once completed, cancelled, or expired.
kind: Optional[Literal["file", "folder"]]Whether the item is a file or a folder. Null when the response was built without that column.
Whether the item is a file or a folder. Null when the response was built without that column.
When the storage last modified this item. Null for a non-storage file, and for a storage item whose modified time has not been stored.
The storage folder this item sits in, or null for a top-level item or a non-storage file.
source: Optional[Literal["googleDrive", "microsoftDrive"]]Where the file came from. googleDrive for a linked Google Drive item, microsoftDrive for a linked OneDrive or SharePoint item. Null for every other file.
Where the file came from. googleDrive for a linked Google Drive item, microsoftDrive for a linked OneDrive or SharePoint item. Null for every other file.
class FileCreateFromStorageResponse: …
When the upload session expires. Null once completed, cancelled, or expired.
kind: Optional[Literal["file", "folder"]]Whether the item is a file or a folder. Null when the response was built without that column.
Whether the item is a file or a folder. Null when the response was built without that column.
When the storage last modified this item. Null for a non-storage file, and for a storage item whose modified time has not been stored.
The storage folder this item sits in, or null for a top-level item or a non-storage file.
source: Optional[Literal["googleDrive", "microsoftDrive"]]Where the file came from. googleDrive for a linked Google Drive item, microsoftDrive for a linked OneDrive or SharePoint item. Null for every other file.
Where the file came from. googleDrive for a linked Google Drive item, microsoftDrive for a linked OneDrive or SharePoint item. Null for every other file.
class FileCreateResponse: …
When the upload session expires. Null once completed, cancelled, or expired.
kind: Optional[Literal["file", "folder"]]Whether the item is a file or a folder. Null when the response was built without that column.
Whether the item is a file or a folder. Null when the response was built without that column.
When the storage last modified this item. Null for a non-storage file, and for a storage item whose modified time has not been stored.
The storage folder this item sits in, or null for a top-level item or a non-storage file.
source: Optional[Literal["googleDrive", "microsoftDrive"]]Where the file came from. googleDrive for a linked Google Drive item, microsoftDrive for a linked OneDrive or SharePoint item. Null for every other file.
Where the file came from. googleDrive for a linked Google Drive item, microsoftDrive for a linked OneDrive or SharePoint item. Null for every other file.
class FileListResponse: …
data: List[Data]Array of file objects for the current page.
Array of file objects for the current page.
When the upload session expires. Null once completed, cancelled, or expired.
kind: Optional[Literal["file", "folder"]]Whether the item is a file or a folder. Null when the response was built without that column.
Whether the item is a file or a folder. Null when the response was built without that column.
When the storage last modified this item. Null for a non-storage file, and for a storage item whose modified time has not been stored.
The storage folder this item sits in, or null for a top-level item or a non-storage file.
source: Optional[Literal["googleDrive", "microsoftDrive"]]Where the file came from. googleDrive for a linked Google Drive item, microsoftDrive for a linked OneDrive or SharePoint item. Null for every other file.
Where the file came from. googleDrive for a linked Google Drive item, microsoftDrive for a linked OneDrive or SharePoint item. Null for every other file.
class FileRetrieveResponse: …
When the upload session expires. Null once completed, cancelled, or expired.
kind: Optional[Literal["file", "folder"]]Whether the item is a file or a folder. Null when the response was built without that column.
Whether the item is a file or a folder. Null when the response was built without that column.
When the storage last modified this item. Null for a non-storage file, and for a storage item whose modified time has not been stored.
The storage folder this item sits in, or null for a top-level item or a non-storage file.
source: Optional[Literal["googleDrive", "microsoftDrive"]]Where the file came from. googleDrive for a linked Google Drive item, microsoftDrive for a linked OneDrive or SharePoint item. Null for every other file.
Where the file came from. googleDrive for a linked Google Drive item, microsoftDrive for a linked OneDrive or SharePoint item. Null for every other file.