Share links
Links that hand files out, or take files in, without an account.
List share links
Returns the share links the caller created. Every link in the workspace is listed under /admin/share-links, which needs an administrator.
query Parameters
cursor^[A-Za-z0-9_-]+$limitoffsetsort^-?[a-z0-9_]+$Headers
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
List share links › Responses
Success
has_moreWhether more rows exist past this page.
next_cursorPass back as cursor for the next page. Null on the last page.
Create a share link
Two kinds, chosen with share_type. A download link — the default — publishes the files in file_ids for someone outside the workspace to fetch. An upload link runs the other way: it lets someone outside send files in without an account.
Both can carry an expiry and a password.
Headers
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Create a share link › Request Body optional
share_typefile_idsnameexpires_atpasswordalbum_idalbum_idspre_tagsmax_filesmax_sizeallow_change_tagsallow_change_albumsCreate a share link › Responses
Created
share_idshare_nameshare_typeshare_activeshare_createdshare_updatedshare_created_byshare_expires_atshare_file_idsshare_album_idshare_optionsshare_view_countshare_download_countshare_max_filesshare_max_sizeshare_created_by_nameshare_file_countshare_upload_countshare_last_upload_atshare_password_setshare_pre_tagsshare_album_idsshare_allow_change_tagsshare_allow_change_albumskiosk_urlGet a share link
Pass include=uploaded_files on an upload link to get what has been sent through it so far.
path Parameters
idquery Parameters
includeHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Get a share link › Responses
Success
share_idshare_nameshare_typeshare_activeshare_createdshare_updatedshare_created_byshare_expires_atshare_file_idsshare_album_idshare_optionsshare_view_countshare_download_countshare_max_filesshare_max_sizeshare_created_by_nameshare_file_countshare_upload_countshare_last_upload_atshare_password_setshare_pre_tagsshare_album_idsshare_allow_change_tagsshare_allow_change_albumskiosk_urlDelete a share link
The link stops working immediately. The files it pointed at are untouched.
path Parameters
idHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Delete a share link › Responses
Success. No content.
Update a share link
Deactivating with share_active: false is how a link is switched off without losing the record of what was shared.
path Parameters
idHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Update a share link › Request Body optional
share_nameshare_activeshare_expires_atshare_passwordshare_max_filesshare_max_sizeshare_allow_change_tagsshare_allow_change_albumsUpdate a share link › Responses
Success
share_idshare_nameshare_typeshare_activeshare_createdshare_updatedshare_created_byshare_expires_atshare_file_idsshare_album_idshare_optionsshare_view_countshare_download_countshare_max_filesshare_max_sizeshare_created_by_nameshare_file_countshare_upload_countshare_last_upload_atshare_password_setshare_pre_tagsshare_album_idsshare_allow_change_tagsshare_allow_change_albumskiosk_url