Citrix ShareFile

ShareFile (now part of Progress Software) is a secure document workflow and file sharing platform that lets teams share files, collect e-signatures, request data from clients, and automate document-centric workflows. The ShareFile v3 REST API provides programmatic access to items, folders, files, users, groups, shares, capabilities, and workflows in a customer subdomain, secured with OAuth 2.0.

1 APIs 0 Features

File SharingDocument WorkflowSecure File TransferE-SignatureClient PortalContent Collaboration

APIs

ShareFile REST API v3

REST API for ShareFile providing access to items, folders, files, users, groups, shares, devices, accounts, and workflows. Authentication uses OAuth 2.0 with multiple supported ...

Collections

Citrix ShareFile REST API v3

OPEN

Resources

Sources

opencollection: 1.0.0
info:
  name: Citrix ShareFile REST API v3
  version: 3.0.0
request:
  auth:
    type: bearer
    token: '{{bearerToken}}'
items:
- info:
    name: Sessions
    type: folder
  items:
  - info:
      name: Authenticate (deprecated; prefer OAuth)
      type: http
    http:
      method: GET
      url: https://{subdomain}.sf-api.com/sf/v3/Sessions/Login
    docs: Authenticate (deprecated; prefer OAuth)
- info:
    name: Items
    type: folder
  items:
  - info:
      name: List root-level items the user has access to
      type: http
    http:
      method: GET
      url: https://{subdomain}.sf-api.com/sf/v3/Items
    docs: List root-level items the user has access to
  - info:
      name: Get an item by id
      type: http
    http:
      method: GET
      url: https://{subdomain}.sf-api.com/sf/v3/Items(:id)
      params:
      - name: id
        value: ''
        type: path
      - name: $select
        value: ''
        type: query
      - name: $expand
        value: ''
        type: query
    docs: Get an item by id
  - info:
      name: Update an item (rename, move)
      type: http
    http:
      method: PATCH
      url: https://{subdomain}.sf-api.com/sf/v3/Items(:id)
      params:
      - name: id
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: Update an item (rename, move)
  - info:
      name: Delete an item
      type: http
    http:
      method: DELETE
      url: https://{subdomain}.sf-api.com/sf/v3/Items(:id)
      params:
      - name: id
        value: ''
        type: path
      - name: singleversion
        value: ''
        type: query
      - name: forceSync
        value: ''
        type: query
    docs: Delete an item
  - info:
      name: List child items of a folder
      type: http
    http:
      method: GET
      url: https://{subdomain}.sf-api.com/sf/v3/Items(:id)/Children
      params:
      - name: id
        value: ''
        type: path
      - name: includeDeleted
        value: ''
        type: query
      - name: $skip
        value: ''
        type: query
      - name: $top
        value: ''
        type: query
    docs: List child items of a folder
  - info:
      name: Create a new folder or file metadata under a parent item
      type: http
    http:
      method: POST
      url: https://{subdomain}.sf-api.com/sf/v3/Items(:id)/Children
      params:
      - name: id
        value: ''
        type: path
      - name: overwrite
        value: ''
        type: query
      - name: passthrough
        value: ''
        type: query
      body:
        type: json
        data: '{}'
    docs: Create a new folder or file metadata under a parent item
  - info:
      name: Download an item's content
      type: http
    http:
      method: GET
      url: https://{subdomain}.sf-api.com/sf/v3/Items(:id)/Download
      params:
      - name: id
        value: ''
        type: path
      - name: includeAllVersions
        value: ''
        type: query
      - name: redirect
        value: ''
        type: query
    docs: Download an item's content
  - info:
      name: Request an upload specification for a parent folder
      type: http
    http:
      method: GET
      url: https://{subdomain}.sf-api.com/sf/v3/Items(:id)/Upload
      params:
      - name: id
        value: ''
        type: path
      - name: method
        value: ''
        type: query
      - name: fileName
        value: ''
        type: query
      - name: fileSize
        value: ''
        type: query
      - name: overwrite
        value: ''
        type: query
    docs: Request an upload specification for a parent folder
- info:
    name: Users
    type: folder
  items:
  - info:
      name: List users in the account
      type: http
    http:
      method: GET
      url: https://{subdomain}.sf-api.com/sf/v3/Users
      params:
      - name: emailAddress
        value: ''
        type: query
      - name: $skip
        value: ''
        type: query
      - name: $top
        value: ''
        type: query
    docs: List users in the account
  - info:
      name: Create a user
      type: http
    http:
      method: POST
      url: https://{subdomain}.sf-api.com/sf/v3/Users
      body:
        type: json
        data: '{}'
    docs: Create a user
  - info:
      name: Get a user
      type: http
    http:
      method: GET
      url: https://{subdomain}.sf-api.com/sf/v3/Users(:id)
      params:
      - name: id
        value: ''
        type: path
    docs: Get a user
  - info:
      name: Update a user
      type: http
    http:
      method: PATCH
      url: https://{subdomain}.sf-api.com/sf/v3/Users(:id)
      params:
      - name: id
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: Update a user
  - info:
      name: Delete a user
      type: http
    http:
      method: DELETE
      url: https://{subdomain}.sf-api.com/sf/v3/Users(:id)
      params:
      - name: id
        value: ''
        type: path
    docs: Delete a user
- info:
    name: Groups
    type: folder
  items:
  - info:
      name: List groups in the account
      type: http
    http:
      method: GET
      url: https://{subdomain}.sf-api.com/sf/v3/Groups
    docs: List groups in the account
  - info:
      name: Create a group
      type: http
    http:
      method: POST
      url: https://{subdomain}.sf-api.com/sf/v3/Groups
      body:
        type: json
        data: '{}'
    docs: Create a group
  - info:
      name: Get a group
      type: http
    http:
      method: GET
      url: https://{subdomain}.sf-api.com/sf/v3/Groups(:id)
      params:
      - name: id
        value: ''
        type: path
    docs: Get a group
  - info:
      name: Update a group
      type: http
    http:
      method: PATCH
      url: https://{subdomain}.sf-api.com/sf/v3/Groups(:id)
      params:
      - name: id
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: Update a group
  - info:
      name: Delete a group
      type: http
    http:
      method: DELETE
      url: https://{subdomain}.sf-api.com/sf/v3/Groups(:id)
      params:
      - name: id
        value: ''
        type: path
    docs: Delete a group
- info:
    name: Shares
    type: folder
  items:
  - info:
      name: List shares
      type: http
    http:
      method: GET
      url: https://{subdomain}.sf-api.com/sf/v3/Shares
    docs: List shares
  - info:
      name: Create a share
      type: http
    http:
      method: POST
      url: https://{subdomain}.sf-api.com/sf/v3/Shares
      body:
        type: json
        data: '{}'
    docs: Create a share
  - info:
      name: Get a share
      type: http
    http:
      method: GET
      url: https://{subdomain}.sf-api.com/sf/v3/Shares(:id)
      params:
      - name: id
        value: ''
        type: path
    docs: Get a share
  - info:
      name: Delete a share
      type: http
    http:
      method: DELETE
      url: https://{subdomain}.sf-api.com/sf/v3/Shares(:id)
      params:
      - name: id
        value: ''
        type: path
    docs: Delete a share
- info:
    name: Accounts
    type: folder
  items:
  - info:
      name: Get the current account information
      type: http
    http:
      method: GET
      url: https://{subdomain}.sf-api.com/sf/v3/Accounts
    docs: Get the current account information
bundled: true