Jump to Content
SideDrawer
API Reference
Log InSideDrawer
API Reference
Log In
API Reference

Overview

  • SideDrawer
  • Our API Design & Protocol
  • Using the SideDrawer APIs
  • HTTP Methods and Response Codes
  • Filtering
  • Pagination

Definitions

  • SideDrawer Structure
  • Glossary
  • Metadata
  • Entities
    • Collaborators
    • Filing Cabinets
    • Drawers
    • Hangers
    • Folders
      • Record Subtypes
      • Record Subtype Specific Fields
    • Files
    • Notifications
    • Reminders
    • Accounts
    • Plan Requests
    • Subscriptions
      • Subscription Features
    • Reports
    • Signatures
    • Cloud Storage
    • Smart Forms Requests
    • Tenants
    • User Roles
    • Team Roles
    • Messages
    • Branding
    • Plans
      • Fields
    • Templates
    • Integrations
    • Webhooks
    • Customer Vaults
    • Smart Forms

Getting Started

  • Access Token Generation
  • Versioning
    • Version Comparisons for Cabinets Endpoints
  • Permissions
  • Guides

Cabinets Gateway

  • Cabinets Endpoints
  • Collaborators
    • Drawer Collaborators
      • List all Drawers (sidedrawer) shared with youget
      • List all of your owned Drawers (sidedrawer)get
      • List all template Drawers (sidedrawer)get
      • Add a Collaborator to a Drawer (sidedrawer)post
      • Remove a Collaborator from a Drawer (sidedrawer)delete
      • Transfer ownership of a Drawer (sidedrawer) to another Userpost
      • Update a Drawer (sidedrawer) Collaboratorput
      • Remove a Collaborator from a Drawer (sidedrawer) using the networkIddelete
      • List all Drawers (sidedrawer) shared with you (paginated)get
      • List Drawers (sidedrawer) you have access to (lite)get
      • List all of your owned Drawers (sidedrawer) (paginated)get
      • Add a Collaborator (including a Team) to a Drawer (sidedrawer)post
      • List all template Drawers (sidedrawer) (paginated)get
    • Folder (Record) Collaborators
      • Add a Collaborator to a Folder (record)post
      • Remove a Collaborator from a Folder (record)delete
      • Update a Folder (record) Collaboratorput
      • Remove a Collaborator from a Folder (record) using the networkIddelete
      • Add a Collaborator (including a Team) to a Folder (record)post
      • List a Folder's (record) Collaboratorsget
    • Hanger (Tile) Collaborators
      • Add a Collaborator for a Hanger (recordType)post
      • List a Hanger's (recordType) Collaboratorsget
      • List a Hanger's (recordType) Collaborators (paginated)get
      • Remove a Collaborator from a Hanger (recordType)delete
    • General
      • List Collaboratorsget
      • List active Collaboratorsget
      • List inactive Collaborators (Invitees)get
      • List "Team"-type Collaboratorsget
      • List your Teamsget
      • List Collaborators (paginated)get
      • List a Drawer's (sidedrawer) or Folder's (record) Collaboratorsget
  • Accounts
    • Retrieve an Account's settingsget
    • Update an Account's settingsput
    • Create an Accountpost
    • Create an Invitationpost
    • Retrieve an Accountget
    • Update an Accountput
    • Delete an Account (admin rights needed)delete
    • List an Account's Teamsget
    • Retrieve an Account by usernameget
    • Retrieve an Account by OpenIDget
    • Log out of Accountdelete
    • Create an Invitationpost
    • Add an email address to an Accountpost
    • Remove an email address from an Accountdelete
    • Add a phone number to an Accountpost
    • Remove a phone number from an Accountdelete
    • Accept Account agreementspost
    • List the Account agreementsget
    • Create an MFA codepost
    • Validate an MFA codeget
    • List all of a User's Filing Cabinetsget
    • List all of a Filing Cabinet's Drawers (sidedrawer)get
  • Drawers
    • Create a Drawer (sidedrawer) for a free Subscriptionpost
    • List a Brand's Drawer (sidedrawer) typesget
    • Update a Drawer (sidedrawer)put
    • Delete a Drawer (sidedrawer)delete
    • Retrieve a Drawer (sidedrawer)get
    • Apply a template to a Drawer (sidedrawer)put
    • Retrieve a Drawer's (sidedrawer) brandingget
    • Retrieve information about a Drawer (sidedrawer)get
    • Retrieve information (lite) about a Drawer (sidedrawer)get
    • Retrieve a Drawer's (sidedrawer) licenseget
    • List all files within a Drawer (sidedrawer)get
    • List all files from cloud storageget
    • Retrieve a Filing Cabinet's Drawers (sidedrawer)get
  • Hangers (Tiles)
    • List Hangers (recordType)get
    • List Record Subtypesget
    • List a Record Subtype's Specific Fieldsget
  • Folders (Records)
    • List a Drawer's (sidedrawer) Folders (record) (paginated)get
    • Update a Folder (record)put
    • Delete a Folder (record)delete
    • Retrieve a Folder (record)get
    • Create a Folder (record)post
    • List a Drawer's (sidedrawer) Folders (record)get
    • Move a Folder (record)put
    • Copy a Folder (record)put
    • Set Folders (record) as "related"post
    • Retrieve a Folder's (record) related Folders (record)get
    • Remove a Folder (record) as "related" to anotherdelete
  • Files
    • Create a file
      • Create a filepost
      • Create file(s)post
    • List a Folder's (record) files
      • List a Folder's (record) filesget
      • List a Folder's (record) files (paginated)get
    • Update a file
      • Update a file (using the file name and extension)put
      • Update a file (using the file token)put
    • Download a file
      • Download a file (using the file name and extension)get
      • Download a file (using the file token)get
    • Delete a file
      • Delete a file (using the file name and extension)delete
      • Delete a file (using the file token)delete
    • Seal a file
      • Seal a file (using the file name and extension)put
      • Seal a file (using the file token)put
    • Send a file to quarantine
      • Send a file to quarantine (using the file name and extension)post
      • Send a file to quarantine (using the file token)post
    • Retrieve a file's metadata
      • Retrieve a file's metadataget
      • Retrieve a file's metadata (using the file token)get
    • Copy a fileput
    • Move a fileput
    • Download a file by stream (using the file token)get
  • Plan Requests
    • List a Drawer's (sidedrawer) available Plansget
    • List a Drawer's (sidedrawer) available Plans (paginated)get
    • Create a Plan Requestpost
    • List a Drawer's (sidedrawer) Plan Requestsget
    • Delete a Plan Requestdelete
    • List a Plan Request's Itemsget
    • Consolidate Items into a Plan Requestpost
    • Update a Plan Request Itemput
    • Delete a Plan Request Itemdelete
  • Notifications
    • Retrieve a Drawer's (sidedrawer) timelineget
    • Retrieve a Drawer's (sidedrawer) logged eventsget
    • Retrieve a Drawer's (sidedrawer) timeline (paginated)get
    • Retrieve a Drawer's (sidedrawer) detailed timelineget
    • Retrieve number of unread Drawer (sidedrawer) timeline notificationsget
    • Mark a Drawer's (sidedrawer) notifications as "read"put
  • Reminders
    • Create a Reminderpost
    • List an entity's Remindersget
    • Update a Reminderput
    • Retrieve a Reminderget
    • Delete a Reminderdelete
    • Update a Reminder's statusput
  • Subscriptions
    • Create a Subscriptionpost
    • Retrieve a Subscription's tax informationget
    • Retrieve the available Subscriptionget
    • Delete a Subscriptiondelete
    • Create a Drawer (sidedrawer) from a Subscriptionpost
    • Create a Customer profile for the current Userpost
    • Retrieve Customer information (using the email address)get
    • Retrieve Customer information (using the customerId)get
    • Add a payment method to a Customerpost
    • List a Customer's payment methodsget
    • Set a payment method as the defaultput
    • Detach a payment method from a Customer's profiledelete
    • Retrieve a Customer's available Subscriptionsget
    • Retrieve the current User's available Subscriptionsget
    • Retrieve the available Subscriptions and pricesget
    • Retrieve a Subscription's informationget
    • Calculate a Subscription priceget
    • Assign a license to a Drawer (sidedrawer)post
    • List available licensesget
    • Detach a license from a Drawer (sidedrawer)delete
    • Increase the number of licensesput
    • Decrease the number of licensesput
    • Send a sponsored Invitation to SideDrawerpost
    • List available licenses (paginated)get
    • Retrieve a Drawer's (sidedrawer) featuresget
    • Retrieve a Customer's featuresget
  • Reports
    • Create a Report for a Drawer (sidedrawer)post
    • List a Drawer's (sidedrawer) Reportsget
    • Retrieve a Report's statusget
    • List a Drawer's (sidedrawer) Report typesget
  • Signatures
    • List a Drawer's (sidedrawer) templatesget
    • Retrieve a templateget
    • Create a signature from a templatepost
    • List a Folder's (record) Envelopesget
    • Retrieve an Envelopeget
  • Cloud Storage
    • List available Integrationsget
    • Retrieve a Drawer's (sidedrawer) cloud drivesget
    • Retrieve a cloud drive's root contentget
    • Retrieve a Folder's (record) cloud content.get
    • Upload a cloud folder to a SideDrawer Folder (record)post
    • Delete a cloud folder from a SideDrawer Folder (record)delete
    • Upload a cloud file to a SideDrawer Folder (record)post
    • Delete a cloud file from a SideDrawer Folder (record)delete
  • Filing Cabinets
    • Create a Filing Cabinetpost
    • List the current User's Filing Cabinetsget
    • Retrieve a Filing Cabinetget
    • Update a Filing Cabinetput
    • Delete a Filing Cabinetdelete
    • Add a Drawer (sidedrawer) to a Filing Cabinetpost
    • Retrieve a Drawer (sidedrawer) from a Filing Cabinetget
    • Remove a Drawer (sidedrawer) from a Filing Cabinetdelete
    • List a Filing Cabinet's Drawers (sidedrawer)get
    • Create a Filing Cabinet for a Drawer (sidedrawer)post
    • List a User's Filing Cabinetsget
    • Create a Filing Cabinet for an Invitee's Drawer (sidedrawer)post
    • Retrieve a Drawer's (sidedrawer) Filing Cabinetsget
    • List an Invitee's Filing Cabinetsget
  • Smart Forms Request
    • List the available Smart Formsget
    • Create a Smart Formpost
    • Retrieve a Drawer's (sidedrawer) Smart Form requestsget
    • Retrieve a Smart Form requestget
    • Delete a Smart Form requestdelete
    • Create a Smart Form request rolepost
    • Delete a Smart Form request roledelete
    • Create a Smart Form screen namepost
    • List Smart Form screen namesget
    • Create a Smart Form section namepost
    • List Smart Form section namesget
    • Delete a Smart Form section namedelete

Blocks Gateway

  • Blocks Endpoints
  • Blocks
    • Upload individual or multiple Blockspost
    • Download multiple Blockspost
    • Download filesget
    • Download files by streamget
  • Health Check
    • Health checkget
  • Signatures
    • Retrieve all document metadataget
    • Retrieve a document's metadataget
  • Cloud Storage
    • Get a cloud folder's contentget
  • Aggregators
    • Download an aggregator fileget

Tenants Gateway

  • Tenants Endpoints
  • Tenant
    • Retrieve an affiliate's (brand) Tenant Accountget
    • List Tenants shared with youget
  • Messages
    • Sync default system Messagespost
    • Create a new Messagepost
    • List Messagesget
    • List Messages of a certain typeget
    • Update a Message templateput
    • Delete a Message templatedelete
  • Subscriptions
    • Create a Subscriptionpost
    • List a Customer's available Subscriptionsget
    • Create a Drawer (sidedrawer) from a Subscription (sends Invitation where applicable)post
    • Create a Drawer (sidedrawer) from a Subscriptionpost
    • Increase the number of licensesput
    • Decrease the number of licensesput
  • Users
    • Create Tenant Userspost
    • Retrieve an affiliate's (brand) or Sponsorship's User Accountget
    • Retrieve a User Account (using the OpenID)get
    • Retrieve a User Account (using the username)get
    • Retrieve a User Account (using the branding or sponsorship)get
    • List a User's Drawers (sidedrawer) and Folders (record)get
  • Invitations
    • Create an Invitationpost
    • List sent Invitationsget
    • List pending sponsored Invitationsget
    • Retrieve a sent Invitationget
    • Delete an Invitationdelete
    • Resend an Invitation emailpost
    • Search Pending Sponsored Invitationsget
    • List sent Invitations (paginated)get
  • Drawers
    • Update a Drawer's (sidedrawer) affiliate code (brandCode), region or other editable attributesput
    • Delete a Drawer (sidedrawer)delete
    • List a Drawer's (sidedrawer) Plan Requestsget
    • Delete an external key from a Drawer (sidedrawer)delete
    • List an affiliate's (brand) Drawers (sidedrawer)get
  • Teams
    • List your Teamsget
    • List a User's Teamsget
    • Create a Teampost
    • List a Tenant's Teamsget
    • Retrieve a Teamget
    • Update a Teamput
    • Remove a Team memberdelete
    • Add a member to a Teampost
    • List a Team's membersget
    • Remove a Team memberdelete
  • Templates
    • Create a Drawer (sidedrawer) Templatepost
    • List Drawer (sidedrawer) Templatesget
    • Delete a Drawer (sidedrawer) Templatedelete
  • Webhooks
    • Create a Webhook subscriptionpost
    • List Webhook subscriptionsget
    • Retrieve a Webhook logget
    • Update a Webhook subscriptionput
    • Retrieve a Webhook subscriptionget
    • Delete a Webhook subscriptiondelete
  • Reports
    • Create a Report requestpost
    • List Reportsget
    • Retrieve a Report's statusget
  • Collaborators
    • Add a Collaborator to a Drawer (sidedrawer)post
    • List a Drawer's (sidedrawer) Collaboratorsget
    • Remove a Drawer (sidedrawer) Collaboratordelete
    • Add a Collaborator to a Drawer (sidedrawer)post
    • List a Drawer's (sidedrawer) Collaboratorsget
  • Filing Cabinets
    • Retrieve a Drawer's (sidedrawer) Filing Cabinetget
    • List a Filing Cabinet's Drawers (sidedrawer)get
    • List a User's Filing Cabinetsget
    • List a User's Filing Cabinet's Drawers (sidedrawer)get
    • List an enterprise's Filing Cabinetsget
    • List an enterprise's Filing Cabinet's Drawers (sidedrawer)get
    • List an Invitee's Filing Cabinetsget
    • List an Invitee's Filing Cabinet's Drawers (sidedrawer)get
  • Customer Vaults
    • Create a Vaultpost
    • List a Tenant's Vaultsget
    • Update a Vaultput
    • Delete a Vaultdelete
    • Retrieve a Vaultget
    • Add a Drawer (sidedrawer) to a Vaultpost
    • Create a Drawer (sidedrawer) Templateget
    • Create a Drawer (sidedrawer) in a Vaultpost
    • Remove a Drawer (sidedrawer) from a Vaultdelete
  • Timeline
    • Retrieve a Tenant's Timelineget
    • Retrieve a Tenant's count of unread notificationsget
    • Mark all notifications as "read"put
  • Health Check
    • Health checkget

Cabinets Endpoints

API endpoints for the front-end and/or for non-Tenant users.

Use the API to manage the following entities (click to jump to related endpoints):

  • Collaborators
  • Drawers
  • Hangers (Tiles)
  • Folders (Records)
  • Files
  • Reminders
  • Notifications
  • Accounts
  • Plan Requests
  • Subscriptions
  • Reports
  • Signatures
  • Cloud Storage
  • Filing Cabinets
  • Smart Forms Requests