Files
Files
The Files model
The name of the file
Optional description of the file
The type of resource. Could be file, folder or url
The full path of the file or folder (includes the file name)
The MIME type of the file.
List Files
List Files
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.
Query parameters
Include raw response. Mostly used for debugging purposes
Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.
Number of records to return
Apply filters (beta)
Apply sorting
Responses
Mapping coverage per connector






Request example
Response example
Upload file
Upload file (max 4MB). Please use the Upload Session API to upload bigger files.
Header parameters
Metadata to attach to the file
ID of the consumer which you want to get or push data from
The ID of your Unify application
Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.
Query parameters
Include raw response. Mostly used for debugging purposes
Responses
Mapping coverage per connector






Request example
Response example
Search Files
Search Files
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.
Request body schema
application/jsonThe query to search for. May match across multiple fields.
Responses
Mapping coverage per connector






Request example
Response example
Get File
Get File
Path parameters
ID of the record you are acting upon.
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.
Query parameters
Include raw response. Mostly used for debugging purposes
Responses
Mapping coverage per connector






Request example
Response example
Delete File
Delete File
Path parameters
ID of the record you are acting upon.
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.
Query parameters
Include raw response. Mostly used for debugging purposes
Responses
Mapping coverage per connector






Request example
Response example
Download File
Download File
Path parameters
ID of the record you are acting upon.
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.
Responses
Mapping coverage per connector






Request example
Response example
Folders
The Folders model
The name of the folder
Optional description of the folder
The full path of the folder (includes the folder name)
The size of the folder in bytes
Create Folder
Create Folder
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.
Query parameters
Include raw response. Mostly used for debugging purposes
Request body schema
application/jsonThe name of the folder.
The parent folder to create the new file within.
Optional description of the folder.
Responses
Mapping coverage per connector






Request example
Response example
Get Folder
Get Folder
Path parameters
ID of the record you are acting upon.
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.
Query parameters
Include raw response. Mostly used for debugging purposes
Responses
Mapping coverage per connector






Request example
Response example
Rename or move Folder
Rename or move Folder
Path parameters
ID of the record you are acting upon.
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.
Query parameters
Include raw response. Mostly used for debugging purposes
Request body schema
application/jsonThe name of the folder.
Optional description of the folder.
The parent folder to create the new file within.
Responses
Mapping coverage per connector






Request example
Response example
Delete Folder
Delete Folder
Path parameters
ID of the record you are acting upon.
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.
Query parameters
Include raw response. Mostly used for debugging purposes
Responses
Mapping coverage per connector






Request example
Response example
Copy Folder
Copy Folder
Path parameters
ID of the record you are acting upon.
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.
Query parameters
Include raw response. Mostly used for debugging purposes
Request body schema
application/jsonThe parent folder to create the new file within.
The name of the folder.
Responses
Mapping coverage per connector






Request example
Response example
Shared Links
The Shared Links model
The URL that can be used to view the file.
The URL that can be used to download the file.
The ID of the file or folder to link.
The scope of the shared link.
Indicated if the shared link is password protected.
List SharedLinks
List SharedLinks
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.
Query parameters
Include raw response. Mostly used for debugging purposes
Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.
Number of records to return
Responses






Request example
Response example
Create Shared Link
Create Shared Link
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.
Query parameters
Include raw response. Mostly used for debugging purposes
Request body schema
application/jsonThe ID of the file or folder to link.
The URL that can be used to download the file.
The scope of the shared link.
Optional password for the shared link.
Responses
Mapping coverage per connector






Request example
Response example
Get Shared Link
Get Shared Link
Path parameters
ID of the record you are acting upon.
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.
Query parameters
Include raw response. Mostly used for debugging purposes
Responses
Mapping coverage per connector






Request example
Response example
Update Shared Link
Update Shared Link
Path parameters
ID of the record you are acting upon.
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.
Query parameters
Include raw response. Mostly used for debugging purposes
Request body schema
application/jsonThe ID of the file or folder to link.
The URL that can be used to download the file.
The scope of the shared link.
Optional password for the shared link.
Responses
Mapping coverage per connector






Request example
Response example
Delete Shared Link
Delete Shared Link
Path parameters
ID of the record you are acting upon.
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.
Query parameters
Include raw response. Mostly used for debugging purposes
Responses
Mapping coverage per connector






Request example
Response example
Upload Sessions
The Upload Sessions model
Indicates if the upload session was completed successfully.
Size in bytes of each part of the file that you will upload. Uploaded parts need to be this size for the upload to be successful.
Indicates if parts of the file can uploaded in parallel.
The range of bytes that was successfully uploaded.
Start Upload Session
Start Upload Session
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.
Query parameters
Include raw response. Mostly used for debugging purposes
Request body schema
application/jsonThe name of the file.
The parent folder to create the new file within.
The size of the file in bytes
Responses
Mapping coverage per connector






Request example
Response example
Get Upload Session
Get Upload Session
Path parameters
ID of the record you are acting upon.
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.
Query parameters
Include raw response. Mostly used for debugging purposes
Responses
Mapping coverage per connector






Request example
Response example
Upload part of file to Upload Session
Upload part of file to Upload Session
Path parameters
ID of the record you are acting upon.
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.
Query parameters
Part number of the file part being uploaded.
Include raw response. Mostly used for debugging purposes
Responses
Mapping coverage per connector






Request example
Response example
Abort Upload Session
Abort Upload Session
Path parameters
ID of the record you are acting upon.
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.
Query parameters
Include raw response. Mostly used for debugging purposes
Responses
Mapping coverage per connector






Request example
Response example
Finish Upload Session
Finish Upload Session
Path parameters
ID of the record you are acting upon.
Header parameters
ID of the consumer which you want to get or push data from
The ID of your Unify application
Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.
Query parameters
Include raw response. Mostly used for debugging purposes
Request body schema
application/jsonResponses
Mapping coverage per connector






Request example
Response example