File sharing

Tags: permissions, sharing

Access shared Files and folders, including folder contents and File downloads.

Resources

Request and response models used by the endpoints on this page.

SharedFileResponse

Field	Type	Required	Description
access	String	✓
createdAt	String	✓
id	Integer	✓
mimeType	String	✓
name	String	✓
shareable	Boolean	✓
size	Integer	✓
title	String	✓

Example:

{
  "id": 0,
  "name": "string",
  "title": "string",
  "size": 0,
  "mimeType": "string",
  "access": "string",
  "shareable": false,
  "createdAt": "string"
}

SharedFolderFilesResponse

Field	Type	Required	Description
files	Array<SharedFileResponse>	✓
pagination	SharedFolderPagination	✓

Example:

{
  "files": [],
  "pagination": null
}

SharedFolderPagination

Field	Type	Required	Description
page	Integer	✓
pageSize	Integer	✓
total	Integer	✓

Example:

{
  "page": 0,
  "pageSize": 0,
  "total": 0
}

SharedFolderResponse

Field	Type	Required	Description
access	String	✓
files	Array<SharedFileResponse>	✓
id	Integer	✓
name	String	✓
pagination	SharedFolderPagination	✓
shareable	Boolean	✓

Example:

{
  "id": 0,
  "name": "string",
  "access": "string",
  "shareable": false,
  "files": [],
  "pagination": null
}

Endpoints

• GET /api/v2/w/{workspace_uuid}/sharing/files/{file_id} - Files
• GET /api/v2/w/{workspace_uuid}/sharing/files/{file_id}/contents/{filename} - Contents
• GET /api/v2/w/{workspace_uuid}/sharing/folders/{folder_id} - Folders
• GET /api/v2/w/{workspace_uuid}/sharing/folders/{folder_id}/files - Files

Files

GET /api/v2/w/{workspace_uuid}/sharing/files/{file_id}

Description:

Get public file metadata.

Returns file information if the file is public or the user has access. Supports unauthenticated access for public files.

Authentication: Requires workspace session

Parameters:

• file_id (Integer)

Response: See SharedFileResponse

---

Contents

GET /api/v2/w/{workspace_uuid}/sharing/files/{file_id}/contents/{filename}

Description:

Serve file contents for shareable files.

Returns the raw file data if the file is shareable and the user has access. Supports unauthenticated access for public shareable files.

Authentication: Requires workspace session

Parameters:

• file_id (Integer)
• filename (String)

Response: Response

---

Folders

GET /api/v2/w/{workspace_uuid}/sharing/folders/{folder_id}

Description:

Get public folder metadata and file listing.

Returns folder information and list of files if the folder is public or user has access. Supports unauthenticated access for public folders.

Authentication: Requires workspace session

Parameters:

• folder_id (Integer)
• page (Integer) — min: 1
• pageSize (Integer) — min: 1, max: 1000

Response: See SharedFolderResponse

---

Files

GET /api/v2/w/{workspace_uuid}/sharing/folders/{folder_id}/files

Description:

Get list of files in a public folder.

Alias for GET /sharing/folders/{folder_id} that returns just the file listing.

Authentication: Requires workspace session

Parameters:

• folder_id (Integer)
• page (Integer) — min: 1
• pageSize (Integer) — min: 1, max: 1000

Response: See SharedFolderFilesResponse

---