Checking authentication...

Shares

Create and manage file shares

6 tools

Get Share

Read Idempotent

POST /v1/tools/sharefile/getShare

Get details of a share (send or request share)

Prefer minimal output: • basic info → summary_only: true • shared files → include_items: true • recipient stats → include_recipients: true Full response only when you need Creator or Parent details.

Parameters

NameTypeRequiredDescription
share_idstringrequiredShare ID to retrieve
include_itemsbooleanoptionalInclude shared items (default false)
include_recipientsbooleanoptionalInclude share recipients (default false)
summary_onlybooleanoptionalEssential fields only (Id, type, title, URI, stats)

Flags

NameTypeDescription
summary_onlybooleanEssential fields only (Id, type, title, URI, stats)

Request

curl -X POST https://api.syncello.io/v1/tools/sharefile/getShare \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"
  -d '{
  "share_id": "example"
}'

Response

{
  "AliasID": "s1a2b3c4d5e6f7089a1b2c3d4e5f6a7b",
  "ShareType": "Send",
  "Title": "Q2 Proposal",
  "HasSentMessage": false,
  "RequireLogin": false,
  "ShareAccessLevel": "Anonymous",
  "CreationDate": "2026-07-02T18:26:36Z",
  "ExpirationDate": "2026-07-09T18:26:36Z",
  "MaxDownloads": -1,
  "TotalDownloads": 0,
  "IsViewOnly": false,
  "Uri": "https://acmefiles.sharefile.com/public/share/web-s1a2b3c4d5e6f7089a1b2c3d4e5f6a7b",
  "Items": [
    {
      "Name": "proposal.pdf",
      "FileName": "proposal.pdf",
      "FileSizeBytes": 204800,
      "odata.type": "ShareFile.Api.Models.File",
      "Id": "fi4d5e6f7-8a9b-0c1d-2e3f-4a5b6c7d8e9f",
      "url": "https://acmefiles.sf-api.com/sf/v3/Items(fi4d5e6f7-8a9b-0c1d-2e3f-4a5b6c7d8e9f)"
    }
  ],
  "Id": "s1a2b3c4d5e6f7089a1b2c3d4e5f6a7b",
  "url": "https://acmefiles.sf-api.com/sf/v3/Shares(s1a2b3c4d5e6f7089a1b2c3d4e5f6a7b)"
}

Alternate mode

{
  "Id": "s1a2b3c4d5e6f7089a1b2c3d4e5f6a7b",
  "ShareType": "Send",
  "Title": "Q2 Proposal",
  "Uri": "https://acmefiles.sharefile.com/public/share/web-s1a2b3c4d5e6f7089a1b2c3d4e5f6a7b",
  "ExpirationDate": "2026-07-09T18:26:36Z",
  "TotalDownloads": 0,
  "MaxDownloads": -1
}

Try It

Try it

Sign in to execute this tool

List Shares

Read Idempotent

POST /v1/tools/sharefile/listShares

List shares created by the current user

List shares created by the current user. Filter by share_type: "Send" for file shares, "Request" for upload requests. By default, expired shares are hidden.

Parameters

NameTypeRequiredDescription
share_typestringoptionalFilter by share type: "Send" or "Request"
Values: Send, Request
topnumberoptionalMaximum number of shares to return
skipnumberoptionalNumber of shares to skip (pagination)
include_expiredbooleanoptionalInclude expired shares (default false)
summary_onlybooleanoptionalReturn only essential fields

Flags

NameTypeDescription
summary_onlybooleanReturn only essential fields

Request

curl -X POST https://api.syncello.io/v1/tools/sharefile/listShares \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

Response

{
  "total_count": 1,
  "returned_count": 1,
  "has_more": false,
  "shares": [
    {
      "AliasID": "s1a2b3c4d5e6f7089a1b2c3d4e5f6a7b",
      "ShareType": "Send",
      "Title": "Q2 Proposal",
      "ShareAccessLevel": "Anonymous",
      "CreationDate": "2026-07-02T18:26:36Z",
      "ExpirationDate": "2026-07-09T18:26:36Z",
      "MaxDownloads": -1,
      "TotalDownloads": 0,
      "IsViewOnly": false,
      "Uri": "https://acmefiles.sharefile.com/public/share/web-s1a2b3c4d5e6f7089a1b2c3d4e5f6a7b",
      "Id": "s1a2b3c4d5e6f7089a1b2c3d4e5f6a7b",
      "url": "https://acmefiles.sf-api.com/sf/v3/Shares(s1a2b3c4d5e6f7089a1b2c3d4e5f6a7b)"
    }
  ]
}

Alternate mode

{
  "total_count": 1,
  "returned_count": 1,
  "has_more": false,
  "summary_only": true,
  "shares": [
    {
      "Id": "s1a2b3c4d5e6f7089a1b2c3d4e5f6a7b",
      "ShareType": "Send",
      "Title": "Q2 Proposal",
      "Uri": "https://acmefiles.sharefile.com/public/share/web-s1a2b3c4d5e6f7089a1b2c3d4e5f6a7b",
      "ExpirationDate": "2026-07-09T18:26:36Z",
      "TotalDownloads": 0,
      "CreationDate": "2026-07-02T18:26:36Z"
    }
  ]
}

Try It

Try it

Sign in to execute this tool

Create Share

Write

POST /v1/tools/sharefile/createShare

Create a new share to send files or request files

Create a share to send or request files. Send Share (share files with others): • share_type: "Send" • items: array of file/folder IDs to share • recipients: optional, email addresses to notify Request Share (request file uploads): • share_type: "Request" • parent_id: folder ID where uploads will go • recipients: optional, email addresses to notify

Parameters

NameTypeRequiredDescription
share_typestringrequiredType of share: "Send" to share files, "Request" to request uploads
Values: Send, Request
itemsarrayoptionalArray of item IDs to share (required for Send shares)
parent_idstringoptionalParent folder ID for Request shares (where uploads will go)
titlestringoptionalTitle/subject for the share
expiration_daysnumberoptionalNumber of days until share expires (default varies by account)
max_downloadsnumberoptionalMaximum number of downloads allowed (-1 for unlimited)
require_loginbooleanoptionalRequire recipients to log in to access
require_user_infobooleanoptionalRequire recipients to provide name/email/company
is_view_onlybooleanoptionalView only mode (no download) for Send shares
notify_on_downloadbooleanoptionalSend notification when files are downloaded
notify_on_uploadbooleanoptionalSend notification when files are uploaded (Request shares)
recipientsarrayoptionalArray of recipient email addresses
personal_messagestringoptionalPersonal message to include in notification emails
cc_senderbooleanoptionalCC the sender on notification emails

Request

curl -X POST https://api.syncello.io/v1/tools/sharefile/createShare \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"
  -d '{
  "share_type": "Send"
}'

Response

{
  "AliasID": "s1a2b3c4d5e6f7089a1b2c3d4e5f6a7b",
  "ShareType": "Send",
  "Title": "Q2 Proposal",
  "HasSentMessage": false,
  "RequireLogin": false,
  "RequireUserInfo": false,
  "ShareAccessLevel": "Anonymous",
  "CreationDate": "2026-07-02T18:26:36Z",
  "ExpirationDate": "2026-07-09T18:26:36Z",
  "MaxDownloads": -1,
  "TotalDownloads": 0,
  "IsViewOnly": false,
  "IsArchived": false,
  "UsesStreamIDs": false,
  "Uri": "https://acmefiles.sharefile.com/public/share/web-s1a2b3c4d5e6f7089a1b2c3d4e5f6a7b",
  "ShareSubType": "None",
  "ShareAccessRight": {
    "DisplayText": "view and download without watermark",
    "AccessRightType": "FullControl",
    "IsWatermarked": false,
    "IsViewOnly": false,
    "odata.type": "ShareFile.Api.Models.ShareAccessRight"
  },
  "Id": "s1a2b3c4d5e6f7089a1b2c3d4e5f6a7b",
  "url": "https://acmefiles.sf-api.com/sf/v3/Shares(s1a2b3c4d5e6f7089a1b2c3d4e5f6a7b)"
}

Try It

Try it

Sign in to execute this tool

Update Share

Write

POST /v1/tools/sharefile/updateShare

Update share settings (expiration, max downloads, etc.)

Update settings for an existing share. Changes can include expiration, download limits, and access requirements.

Parameters

NameTypeRequiredDescription
share_idstringrequiredID of the share to update
titlestringoptionalUpdated title
expiration_datestringoptionalNew expiration date (ISO 8601)
max_downloadsnumberoptionalNew max downloads (-1 for unlimited)
require_loginbooleanoptionalRequire login to access
require_user_infobooleanoptionalRequire user info to access
is_view_onlybooleanoptionalEnable/disable view only mode

Request

curl -X POST https://api.syncello.io/v1/tools/sharefile/updateShare \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"
  -d '{
  "share_id": "example"
}'

Response

{
  "AliasID": "s1a2b3c4d5e6f7089a1b2c3d4e5f6a7b",
  "ShareType": "Send",
  "Title": "Q2 Proposal (Updated)",
  "ShareAccessLevel": "Anonymous",
  "CreationDate": "2026-07-02T18:26:36Z",
  "ExpirationDate": "2026-07-16T18:26:36Z",
  "MaxDownloads": 5,
  "TotalDownloads": 0,
  "IsViewOnly": true,
  "Uri": "https://acmefiles.sharefile.com/public/share/web-s1a2b3c4d5e6f7089a1b2c3d4e5f6a7b",
  "Id": "s1a2b3c4d5e6f7089a1b2c3d4e5f6a7b",
  "url": "https://acmefiles.sf-api.com/sf/v3/Shares(s1a2b3c4d5e6f7089a1b2c3d4e5f6a7b)"
}

Try It

Try it

Sign in to execute this tool

Delete Share

Destructive

POST /v1/tools/sharefile/deleteShare

Delete a share (revoke access)

Delete a share to revoke all access. Recipients will no longer be able to access the shared files/upload link.

Parameters

NameTypeRequiredDescription
share_idstringrequiredID of the share to delete

Request

curl -X POST https://api.syncello.io/v1/tools/sharefile/deleteShare \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"
  -d '{
  "share_id": "example"
}'

Response

{
  "message": "Share s1a2b3c4d5e6f7089a1b2c3d4e5f6a7b deleted successfully"
}

Try It

Try it

Sign in to execute this tool

Send Share Notification

Write

POST /v1/tools/sharefile/sendShareNotification

Send or resend share notification emails to recipients

Send or resend share notification emails. Can be used to notify new recipients or remind existing ones.

Parameters

NameTypeRequiredDescription
share_idstringrequiredID of the share
recipientsarrayrequiredEmail addresses of recipients to notify
personal_messagestringoptionalPersonal message to include in the email
cc_senderbooleanoptionalCC the sender on the notification

Request

curl -X POST https://api.syncello.io/v1/tools/sharefile/sendShareNotification \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"
  -d '{
  "share_id": "example",
  "recipients": "..."
}'

Response

{
  "message": "Share notification sent to 1 recipient(s)",
  "recipients": [
    "dana@northwind.example.com"
  ]
}

Try It

Try it

Sign in to execute this tool