ShareFile API
  • Not Currently Logged In |
    Log In
  • ||
    Logout
  • arrow Getting Started
    • Quick Start Guide
    • OData Implementation
    • FAQ
    • Authentication
    • Postman
    • Storage Zones
  • Get an API Key
  • arrow API Entities
    • AccessControls
    • Accounts
    • Apps
    • AsyncOperations
    • Capabilities
    • ConnectorGroups
    • Devices
    • EncryptedEmails
    • FavoriteFolders
    • Favorites
    • FolderTemplates
    • Groups
    • Items
    • Metadata
    • Policies
    • Reports
    • Sessions
    • Shares
    • StorageCenters
    • Users
    • WebhookClients
    • WebhookSubscriptions
    • Workflows
    • Zones
  • arrowWebhooks
    • Overview
    • Events
    • Payloads
    • Signature Keys
  • arrowHow-To Guides
    • Common Use Cases
    • Troubleshooting
  • arrowCode Samples
    • C#(.NET)
    • Command Line / CURL
    • PHP
    • Python
    • Ruby
    • VB(.NET)
  • arrowSDKs
    • PowerShell
    • .NET
    • JavaScript
  • Terms of Use

Available Resources

Access Controls

Access Controls define the permissions and options of a Principal (User or Group) to a given Item (Folder).

Accounts

Accounts represent an isolated customer area in ShareFile.com.

Async Operations

AsyncOperations represent long-lived operations that are started by users, but are not completed immediately.

Capabilities

ShareFile supports multiple data providers, the Capabilities of which can be accessed here.

Favorite Folders

FavoriteFolders are user selectable "bookmarks" to often used folders.

Groups

ShareFile Distribution Groups allow employees to organize groups of users to be able to easily add them to a folder or send files to or receive file from them.

Items

Items are the File, Folder, Link, Note, and Symbolic Link entities with which you interact inside ShareFile account.

Sessions

Sessions represent an Authenticated context in the ShareFile API.

Shares

Requests and Sends.

Storage Centers

Zones and StorageCenters objects represent Storage Zones - hosted or on-premise areas that provide data repository services

Users

Your ShareFile account contains client and employee users that can be managed using this resource. The Manage Users page is the analogous web portal page.