Jump to Content
API Reference
v2407.002
v2408.001
Log In
API Reference
Log In
v2408.001
API Reference
Health check
Search
JUMP TO
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 you
get
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 User
post
Update a Drawer (sidedrawer) Collaborator
put
Remove a Collaborator from a Drawer (sidedrawer) using the networkId
delete
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) Collaborator
put
Remove a Collaborator from a Folder (record) using the networkId
delete
Add a Collaborator (including a Team) to a Folder (record)
post
List a Folder's (record) Collaborators
get
Hanger (Tile) Collaborators
Add a Collaborator for a Hanger (recordType)
post
List a Hanger's (recordType) Collaborators
get
List a Hanger's (recordType) Collaborators (paginated)
get
Remove a Collaborator from a Hanger (recordType)
delete
General
List Collaborators
get
List active Collaborators
get
List inactive Collaborators (Invitees)
get
List "Team"-type Collaborators
get
List your Teams
get
List Collaborators (paginated)
get
List a Drawer's (sidedrawer) or Folder's (record) Collaborators
get
Accounts
Retrieve an Account's settings
get
Update an Account's settings
put
Create an Account
post
Create an Invitation
post
Retrieve an Account
get
Update an Account
put
Delete an Account (admin rights needed)
delete
List an Account's Teams
get
Retrieve an Account by username
get
Retrieve an Account by OpenID
get
Log out of Account
delete
Create an Invitation
post
Add an email address to an Account
post
Remove an email address from an Account
delete
Add a phone number to an Account
post
Remove a phone number from an Account
delete
Accept Account agreements
post
List the Account agreements
get
Create an MFA code
post
Validate an MFA code
get
List all of a User's Filing Cabinets
get
List all of a Filing Cabinet's Drawers (sidedrawer)
get
Drawers
Create a Drawer (sidedrawer) for a free Subscription
post
List a Brand's Drawer (sidedrawer) types
get
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) branding
get
Retrieve information about a Drawer (sidedrawer)
get
Retrieve information (lite) about a Drawer (sidedrawer)
get
Retrieve a Drawer's (sidedrawer) license
get
List all files within a Drawer (sidedrawer)
get
List all files from cloud storage
get
Retrieve a Filing Cabinet's Drawers (sidedrawer)
get
Hangers (Tiles)
List Hangers (recordType)
get
List Record Subtypes
get
List a Record Subtype's Specific Fields
get
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 another
delete
Files
Create a file
Create a file
post
Create file(s)
post
List a Folder's (record) files
List a Folder's (record) files
get
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 metadata
get
Retrieve a file's metadata (using the file token)
get
Copy a file
put
Move a file
put
Download a file by stream (using the file token)
get
Plan Requests
List a Drawer's (sidedrawer) available Plans
get
List a Drawer's (sidedrawer) available Plans (paginated)
get
Create a Plan Request
post
List a Drawer's (sidedrawer) Plan Requests
get
Delete a Plan Request
delete
List a Plan Request's Items
get
Consolidate Items into a Plan Request
post
Update a Plan Request Item
put
Delete a Plan Request Item
delete
Notifications
Retrieve a Drawer's (sidedrawer) timeline
get
Retrieve a Drawer's (sidedrawer) logged events
get
Retrieve a Drawer's (sidedrawer) timeline (paginated)
get
Retrieve a Drawer's (sidedrawer) detailed timeline
get
Retrieve number of unread Drawer (sidedrawer) timeline notifications
get
Mark a Drawer's (sidedrawer) notifications as "read"
put
Reminders
Create a Reminder
post
List an entity's Reminders
get
Update a Reminder
put
Retrieve a Reminder
get
Delete a Reminder
delete
Update a Reminder's status
put
Subscriptions
Create a Subscription
post
Retrieve a Subscription's tax information
get
Retrieve the available Subscription
get
Delete a Subscription
delete
Create a Drawer (sidedrawer) from a Subscription
post
Create a Customer profile for the current User
post
Retrieve Customer information (using the email address)
get
Retrieve Customer information (using the customerId)
get
Add a payment method to a Customer
post
List a Customer's payment methods
get
Set a payment method as the default
put
Detach a payment method from a Customer's profile
delete
Retrieve a Customer's available Subscriptions
get
Retrieve the current User's available Subscriptions
get
Retrieve the available Subscriptions and prices
get
Retrieve a Subscription's information
get
Calculate a Subscription price
get
Assign a license to a Drawer (sidedrawer)
post
List available licenses
get
Detach a license from a Drawer (sidedrawer)
delete
Increase the number of licenses
put
Decrease the number of licenses
put
Send a sponsored Invitation to SideDrawer
post
List available licenses (paginated)
get
Retrieve a Drawer's (sidedrawer) features
get
Retrieve a Customer's features
get
Reports
Create a Report for a Drawer (sidedrawer)
post
List a Drawer's (sidedrawer) Reports
get
Retrieve a Report's status
get
List a Drawer's (sidedrawer) Report types
get
Signatures
List a Drawer's (sidedrawer) templates
get
Retrieve a template
get
Create a signature from a template
post
List a Folder's (record) Envelopes
get
Retrieve an Envelope
get
Cloud Storage
List available Integrations
get
Retrieve a Drawer's (sidedrawer) cloud drives
get
Retrieve a cloud drive's root content
get
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 Cabinet
post
List the current User's Filing Cabinets
get
Retrieve a Filing Cabinet
get
Update a Filing Cabinet
put
Delete a Filing Cabinet
delete
Add a Drawer (sidedrawer) to a Filing Cabinet
post
Retrieve a Drawer (sidedrawer) from a Filing Cabinet
get
Remove a Drawer (sidedrawer) from a Filing Cabinet
delete
List a Filing Cabinet's Drawers (sidedrawer)
get
Create a Filing Cabinet for a Drawer (sidedrawer)
post
List a User's Filing Cabinets
get
Create a Filing Cabinet for an Invitee's Drawer (sidedrawer)
post
Retrieve a Drawer's (sidedrawer) Filing Cabinets
get
List an Invitee's Filing Cabinets
get
Smart Forms Request
List the available Smart Forms
get
Create a Smart Form
post
Retrieve a Drawer's (sidedrawer) Smart Form requests
get
Retrieve a Smart Form request
get
Delete a Smart Form request
delete
Create a Smart Form request role
post
Delete a Smart Form request role
delete
Create a Smart Form screen name
post
List Smart Form screen names
get
Create a Smart Form section name
post
List Smart Form section names
get
Delete a Smart Form section name
delete
Blocks Gateway
Blocks Endpoints
Blocks
Upload individual or multiple Blocks
post
Download multiple Blocks
post
Download files
get
Download files by stream
get
Health Check
Health check
get
Signatures
Retrieve all document metadata
get
Retrieve a document's metadata
get
Cloud Storage
Get a cloud folder's content
get
Aggregators
Download an aggregator file
get
Tenants Gateway
Tenants Endpoints
Tenant
Retrieve an affiliate's (brand) Tenant Account
get
List Tenants shared with you
get
Messages
Sync default system Messages
post
Create a new Message
post
List Messages
get
List Messages of a certain type
get
Update a Message template
put
Delete a Message template
delete
Subscriptions
Create a Subscription
post
List a Customer's available Subscriptions
get
Create a Drawer (sidedrawer) from a Subscription (sends Invitation where applicable)
post
Create a Drawer (sidedrawer) from a Subscription
post
Increase the number of licenses
put
Decrease the number of licenses
put
Users
Create Tenant Users
post
Retrieve an affiliate's (brand) or Sponsorship's User Account
get
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 Invitation
post
List sent Invitations
get
List pending sponsored Invitations
get
Retrieve a sent Invitation
get
Delete an Invitation
delete
Resend an Invitation email
post
Search Pending Sponsored Invitations
get
List sent Invitations (paginated)
get
Drawers
Update a Drawer's (sidedrawer) affiliate code (brandCode), region or other editable attributes
put
Delete a Drawer (sidedrawer)
delete
List a Drawer's (sidedrawer) Plan Requests
get
Delete an external key from a Drawer (sidedrawer)
delete
List an affiliate's (brand) Drawers (sidedrawer)
get
Teams
List your Teams
get
List a User's Teams
get
Create a Team
post
List a Tenant's Teams
get
Retrieve a Team
get
Update a Team
put
Remove a Team member
delete
Add a member to a Team
post
List a Team's members
get
Remove a Team member
delete
Templates
Create a Drawer (sidedrawer) Template
post
List Drawer (sidedrawer) Templates
get
Delete a Drawer (sidedrawer) Template
delete
Webhooks
Create a Webhook subscription
post
List Webhook subscriptions
get
Retrieve a Webhook log
get
Update a Webhook subscription
put
Retrieve a Webhook subscription
get
Delete a Webhook subscription
delete
Reports
Create a Report request
post
List Reports
get
Retrieve a Report's status
get
Collaborators
Add a Collaborator to a Drawer (sidedrawer)
post
List a Drawer's (sidedrawer) Collaborators
get
Remove a Drawer (sidedrawer) Collaborator
delete
Add a Collaborator to a Drawer (sidedrawer)
post
List a Drawer's (sidedrawer) Collaborators
get
Filing Cabinets
Retrieve a Drawer's (sidedrawer) Filing Cabinet
get
List a Filing Cabinet's Drawers (sidedrawer)
get
List a User's Filing Cabinets
get
List a User's Filing Cabinet's Drawers (sidedrawer)
get
List an enterprise's Filing Cabinets
get
List an enterprise's Filing Cabinet's Drawers (sidedrawer)
get
List an Invitee's Filing Cabinets
get
List an Invitee's Filing Cabinet's Drawers (sidedrawer)
get
Customer Vaults
Create a Vault
post
List a Tenant's Vaults
get
Update a Vault
put
Delete a Vault
delete
Retrieve a Vault
get
Add a Drawer (sidedrawer) to a Vault
post
Create a Drawer (sidedrawer) Template
get
Create a Drawer (sidedrawer) in a Vault
post
Remove a Drawer (sidedrawer) from a Vault
delete
Timeline
Retrieve a Tenant's Timeline
get
Retrieve a Tenant's count of unread notifications
get
Mark all notifications as "read"
put
Health Check
Health check
get
Health check
get
https://api-sbx.sidedrawersbx.com/api/metrics
Language
Shell
Node
Ruby
PHP
Python
RESPONSE
Click
Try It!
to start a request and see the response here!
