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

Welcome to the ShareFile API

Integrate with other services and build tools and applications on top of ShareFile

  • Icon_step1

    Get an API Key

    Get started right away - request your API key.

  • Icon_step2

    Browse the documentation

    Learn how the API works and what it can do.

  • Icon_step3

    Get Help

    Stuck somewhere? Check out our developers' forum.

How do I get started?

You'll need a ShareFile account, first of all. Then you grab an API key for each app you want to build from your account settings page.

We recommend that you start out by checking out our Quick Start Guide and then learn how to authenticate with us, before you dive into the code samples and the documentation.

The "How-to Guides" will get you started on common ShareFile use cases, as well as help you troubleshoot issues

You will probably also want to look at our client libraries to see if we have one available for your prefered language or platform.

So What's New?

The ShareFile REST API uses a subset of the ODATA specification. ODATA is an HTTP-based REST API, with standards for how to describe objects and actions. Below you will find more details on ShareFile's ODATA implementation and the available resources.

Check out the ShareFile PowerShell SDK for accessing the ShareFile API through a PowerShell snapin.

We also have SDKs for .NET, as well as JavaScript tools, which can be found in our SDKs site.