Jump to Content
API Reference
v1.0
Log In
API Reference
Log In
v1.0
API Reference
Customer Vaults
All
Pages
Start typing to 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
Accounts
Accounts Exist
Accounts Request
Accounts Response
Accounts Update
Address
Aggregator Deliveries
Agreement Request
Applications
Front-end Applications
Back-end Applications
Application Logins
Developer Logins
User Logins
Assign License
Batch
Body Request MFA Code
Branding
Card
Cloud Storage
Collaborators
Connections
Contributor Groups
Contributor Transfer
Create Filing Cabinet
Create or Update Filing Cabinet
Create Response
Customer
Customer Vaults
Delete Network Record
Delete Network Sidedrawer
Detach License
Display Value
Drawers
Email
Error Responses
External Keys
Federation Groups
Files
Filing Cabinets
Folders
Record Subtypes
Record Subtype Specific Fields
Hangers
Increase License
Integrations
List Sidedrawer Filing Cabinet Response
Messages
Network Record
Network Record V2
Network Record Group
Network Record Update
Network Response
Network Sidedrawer
Network Sidedrawer V2
Network Update Sidedrawer
Notifications
Payment Address
Payment Methods
Phone
Plans
Fields
Plan Requests
Plans Items
Recipients
Records Type Home
Record Block Data
Record
Record V2
Record Files Body V1
Record Files Body V2
Record Files
Record Files Response
Records Copy
Records File Copy V1
Records File Copy V2
Records File Move V2
Records Move
Records Response
Records Sections
Records Short Response
Records SubType
Records SubType Response
Records SubType Specific Fields
Records Tag
Records Tag Response
Records Type
Records Type Response
Recurrent
Relation
Reminders
Reminders To
Reminders Update
Reports
Report Request
Requests
Requests V2
Schedule
Sections
Send Message Response
Setting
SideDrawer Filing Cabinet Response
Sidedrawer Home
Sidedrawer Response
Sidedrawer Template
Sidedrawer Update
Signatures
Smart Forms
Smart Forms Requests
Smart Forms Roles
Smart Forms Sidedrawer
Subscriptions
Subscription Features
Team Roles
Templates
Template Deliveries
Template Signature
Tenants
Transfer Ownership
Update Record Files
User Roles
Validation
Webhooks
Getting Started
Access Token Generation
Versioning
Version Comparisons for Cabinets Endpoints
Permissions
Guides
Setting Up an Account
Logging In
Creating a Drawer (sideDrawer)
Creating a Folder (record)
Adding and Managing Collaborators
Moving & Copying Files
Downloading a File
Basic Tenant Pathway
Linking Folders (records)
Creating a Team
Blocks
Setting a Reminder
Requesting Info
Subscriptions and Drawers
Plans and Info Requests
Requesting Signatures
Adding Integrations
Applications
Cabinets Gateway
Collaborators
Add a Collaborator to a Folder (record)
post
Remove a Collaborator from a Folder (record)
del
Update a Folder (record) Collaborator
put
Remove a Collaborator from a Folder (record) using the networkId
del
Add a Collaborator (including a Team) to a Folder (record)
post
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)
del
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
del
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
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
List a Folder's (record) Collaborators
get
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)
del
Folders (Records)
List a Drawer's (sidedrawer) Folders (record) (paginated)
get
Update a Folder (record)
put
Delete a Folder (record)
del
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
get
Remove a Folder (record) as "related" to another
del
Drawers (Sidedrawers)
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)
del
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 Drawer's (sidedrawer) Filing Cabinets
get
Retrieve a Filing Cabinet's Drawers (sidedrawer)
get
Check email availabillity for sidedrawer
get
Files
Create a file
post
Get Record files from cloud storage folder
get
Get Record files from cloud storage folder
get
Download Record File by stream
get
Copy Record Files
put
List a Folder's (record) files
get
Update a file (using the file name and extension)
put
Delete a file (using the file name and extension)
del
Seal a file (using the file name and extension)
put
Send a file to quarantine (using the file name and extension)
post
Retrieve a file's metadata
get
Create file(s)
post
List a Folder's (record) files (paginated)
get
Download a file (using the file name and extension)
get
Download a file (using the file token)
get
Update a file (using the file token)
put
Delete a file (using the file token)
del
Copy a file
put
Move a file
put
Seal a file (using the file token)
put
Send a file to quarantine (using the file token)
post
Retrieve a file's metadata (using the file token)
get
Download a file by stream (using the file token)
get
Reminders
Create a Reminder
post
List an entity's Reminders
get
Update a Reminder
put
Retrieve a Reminder
get
Delete a Reminder
del
Update a Reminder's status
put
List Reminders
get
Tiles (Hangers)
List Hangers (recordType)
get
List Record Subtypes
get
List a Record Subtype's Specific Fields
get
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
Save a note into the timeline
post
Get the timeline notes
get
Pin note
put
Unpin note
put
Delete a note in the timeline
del
Get sidedrawer unread notifications count
get
Get Drawer (sidedrawer) notifications
get
Mark notification as read
put
Mark notification as unread
put
Mark all Drawer notifications as unread
put
Mark all Drawer notifications as read
put
Delete notification
del
Get Drawer's (sidedrawer) raw log
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)
del
List an Account's Teams
get
Retrieve an Account by username
get
Retrieve an Account by OpenID
get
Log out of Account
del
Create an Invitation
post
Add an email address to an Account
post
Remove an email address from an Account
del
Add a phone number to an Account
post
Remove a phone number from an Account
del
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
Resend invitation Email
post
Get Invitation Hash
get
Available agreements by BrandCode
get
Get specific agreement
get
Get invitations by code
get
Check if the username is already taken
get
Available agreements
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
del
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
del
Get Plan Requests with pagination
get
Subscriptions
Create a Subscription
post
Retrieve a Subscription's tax information
get
Retrieve the available Subscription
get
Delete a Subscription
del
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
del
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)
del
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
Create Sidedrawer from Subscription
post
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
Get Templates
get
Create Signature from Template
post
List Envelopes
get
Retrieve an Envelope
get
Get Envelope
get
Get 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 cloud content.
get
Upload a cloud folder to a SideDrawer Folder (record)
post
Delete a cloud folder from a SideDrawer Folder (record)
del
Upload a cloud file to a SideDrawer Folder (record)
post
Delete a cloud file from a SideDrawer Folder (record)
del
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
del
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
del
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
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
del
Create a Smart Form request role
post
Delete a Smart Form request role
del
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
del
Check Smart Form Request Signature status
get
Update Smart Form Request Signature status
post
Delete Smart Forms Request Signature status
del
Remove onCompleteReportId form reports
del
Network
Get Network
get
Tenants Gateway
Workflow Automations
Create workflow automation
post
List workflow automations
get
Get workflow automation by ID
get
Delete workflow automation
del
Update workflow automation
put
Execute workflow automation manually
put
List automation execution history
get
Get detailed automation execution with action runs
get
Execute automation via webhook trigger
post
Export workflow automation with dependencies
get
Import workflow automation with dependencies
post
Webhooks
Create Webhook subscription
post
Get list of Webhook Subscriptions
get
Create Webhook subscription
get
Update Webhook subscription
put
Get Webhook subscription
get
Delete Webhook subscription
del
Get webhook logs by business events and subscription ID
get
Create Webhook subscription
post
Get list of Webhook Subscriptions
get
Create Webhook subscription
get
Update Webhook subscription
put
Get Webhook subscription
get
Delete Webhook subscription
del
Branding
Get brandings
get
Create branding
post
Get brandings
get
Update branding
put
Delete brand by id
del
Get brandings by brand code
get
Create branding flavour
post
Get flavours for giving branding
get
Get flavours by id
get
Update flavours by id
put
Get flavours by id
del
Create branding default sidedrawer
post
Get default sidedrawers for giving branding
get
Get default sidedrawer by id
get
Update default sidedrawer by id
put
Delete default sidedrawer by id
del
Comments
Create comment
post
Get comments
get
Update comment
put
Delete comment
del
Get comments archive
get
Get comments unread count
get
Mark comments as read
put
Marketplace - OAuth Configuration
Generate OAuth consent URL
get
Complete OAuth authorization
get
Marketplace - Export/Import
Export Marketplace Configuration
get
Import Marketplace Configuration
post
Connections
Find Connections from tenant
get
Create a Connection
post
Get Connection by Id
get
Update Connection
put
Delete Connection
del
Api to Test Connection Endpoint
get
Subscriptions
Create Subscriptions
post
Get available Subscription by customerId
get
Create Sidedrawer from Subscription
post
Create Sidedrawer from Subscription
post
Delete Subscription by id
del
Get available customer by email (only for Stripe subsriptions).
get
Add payments methods to customers (only for Stripe subscriptions)
post
Get payment methods from Tenant (just for Stripe subscriptions).
get
Set payment methods as default (just for Stripe subscriptions).
put
Detach payment method (just for Stripe subscriptions).
del
Assign licenses To existing User
post
Get available licenses by subscription id
get
Detach licenses To existing User
del
Increase licenses
put
Decrease licenses
put
Record Types
Create Custom Record types
post
List Record types
get
List Tenant Sidedrawer types
get
Get Record types by Name
get
Delete Record types
del
Update Record types
put
Users
Create tenant assumed role Users
post
Get users account by branding or sponsorships
get
Create tenant assumed role Users
post
Get User account by OpenID
get
Get account by username
get
Update account
put
Get account by OpenID
get
Delete user account by OpenID with tenant validation
del
Lock account
put
Unlock account
put
Reset Password Email
put
Migrate account from one OpenID to another (Auth0 Keycloak) with tenant validation
put
Get users account by branding or sponsorships
get
List user Sidedrawers and Records
get
Get account by OpenID
post
Validate otp code by OpenID
get
Invitations
Create invitation
post
Search invitations
get
Search pending sponsored invitations
get
Get invitations by code
get
Create invitation
put
Delete invitations
del
Resend invitation Email
post
Create temporary password
post
Lock invitation
put
Unlock invitation
put
List invitation Sidedrawers and Records
get
Search pending sponsored invitations
get
Search invitations with advanced filtering and date-based queries
get
File Delivery
Create Files bulk delivery
post
Get files bulk deliveries
get
Draft Files bulk delivery
post
Sign-off Files bulk delivery
put
Get files bulk deliveries by delivery
get
Get files bulk deliveries by delivery
get
reprocess files bulk deliveries by delivery
put
Get files bulk deliveries by delivery
get
Get files bulk deliveries by delivery
put
Rollback Files bulk delivery
put
Get files bulk deliveries
get
Get files bulk deliveries by delivery
get
Tenant
Create Tenant Account
post
Get tenant by Brand Code
get
Get tenants shared with the logged user
get
Update Tenant Account
put
User Roles
List employee users
get
Get employee user role
get
Set employee role to a user
post
Update employee role to a user
put
Remove employee role to a user
del
Transfer ownership
put
List employee pending users
get
Set employee role to a pending user
post
Set employee role to a pending user
put
Delete employee role to a pending user
del
Teams Roles
Get Team role
get
Assign role to a Team
post
Update role to a Team
put
Remove Team role
del
Applications
Get Applications from tenant
get
Create a Frontend Application
post
Create a Backend Application
post
Get Developer account by clientId
get
Update Developer Account
put
Delete Developer account
del
Rotate Developer secret
put
Applications Login
Get Developer Management Token
post
Get User M2M Token for API Navigation
post
Use SideDrawer login screen for a Frontend application
get
Federation Groups
Get federation groups
get
Create federation group
post
Get federation group by Id
get
Update federation group
put
Remove federation group
del
Files
Upload Files to Sidedrawer CDN
post
List files from Sidedrawer CDN
get
Download Files
get
Remove Files
del
Filing Cabinets
List Filing Cabinets of a given Sidedrawer
get
List Sidedrawers of a given Filing Cabinet
get
List Filing Cabinets by OpenID
get
List Sidedrawers of a given Filing Cabinet by OpenID
get
List Filing Cabinets by by Federation id
get
List Sidedrawers of a given Filing Cabinet by Federation id
get
List Filing Cabinets by invitation code
get
List Sidedrawers of a given Filing Cabinet by invitation code
get
Integrations Config
generate consent for provider
get
Endpoint requeste when the consent is given
get
Integrations
Create external Integrations
post
Get integrations by tenantId
get
Get integrations by id
get
Update Developer Integrations
put
Delte integrations by id
del
reset integrations configuration by id
del
Key Delivery
Create Files bulk delivery
post
Create Files bulk delivery
del
Get key deliveries
get
Create Files bulk delivery (JSON)
post
Delete Files bulk delivery (JSON)
del
Get delivery
get
Get key delivery items
get
Get key delivery item
get
Marketplace - Connections
Create external marketplace connection
post
List marketplace connections
get
Create internal marketplace connection
post
Get connections by id
get
Update Developer Connections
put
Delete connections by id
del
reset connections configuration by id
del
Export Connection Data
get
Import Connection Data
post
Marketplace - Requests
Create marketplace request
post
List marketplace requests by connection
get
Get marketplace request by ID
get
Update marketplace request
put
Delete marketplace request
del
Test external Request
post
Export marketplace request
get
Import marketplace request
post
Sidedrawer Networks
Create Sidedrawer Network
post
List Sidedrawer Network
get
Delete Sidedrawer Network by Id
del
Create Sidedrawer Network
post
List Sidedrawer Network
get
Messages
Sync messages with default ones
post
Create new Message
post
Get messages
get
Get specific messages
get
Update a Message Template
put
Delete a message template
del
Deliver a notification to specific users
post
Plans
Create Plan Request
post
Get Plan Requests
get
Get Plan Requests by branding
get
Get Plan Request
get
Update Plan Request
put
Delete Plan Request
del
Create Plan Request Item
post
Get Plan Request Items
get
Get specific Plan Request item
get
Update Plan Request item order Id
put
Delete Plan Request item
del
Get Plan Request Sidedrawers
get
Get Plan Requests
get
List plan requests
get
Get Plan Request Sidedrawers
get
Plan Requests
Update Plan Request
put
Aggregators
Get Portfolio Views
get
Get Entity Types
get
Get Entities
get
Get Portfolio
get
Get Generated Reports
get
Get Report Files
get
Assign file to Record
post
Unassing file from Record
del
Aggregators Delivery
Create Files bulk delivery
post
Get files bulk deliveries
get
Get files bulk deliveries by delivery
get
Get files bulk deliveries by delivery
get
reprocess files bulk deliveries by delivery
put
Get files bulk deliveries by delivery
get
Get files bulk deliveries by delivery
put
Record SubTypes
Create Record Sub types
post
List Record SubTypes
get
Get record sub-type by Name
get
Delete Record Sub types
del
Update Record Sub types)
put
Record SubTypes specific fields
Create Record Sub types specific fields
post
List Record SubType Specific field
get
Delete Record Sub types specific fields (Needs Admin Rights)
del
Update Record Sub types specific fields
put
Smart Forms
Create Smart Form
post
List Smart Form Screens
get
Create Smart Form Screens
put
Create Smart Form Screens
del
Create Smart Form Screens
post
List Smart Form Screens
get
Update Smart Form Screens
put
Update Smart Form Screens
del
Create Smart Form Sections
post
List Smart Form Sections
get
Update Smart Form Sections
put
Update Smart Form Sections
del
Create Smart Form Items
post
Get Smart Form Items
get
Create Smart Form Items
put
Create Smart Form Items
del
Available Smart Forms
get
Create Smart Forms
post
Get Smart Forms Request
get
Update Smart Forms Request
put
Get Smart Form Screens and Items by ID
get
get Smart Form screens/sections and items by Id
post
get Smart Form screens/sections and items by Id
post
get Smart Form screens/sections and items by Id
del
get Smart Form screens/sections and items by Id
del
Export Smart Form Structure
get
Import Smart Form Structure
post
Reports
Create Report Request
post
Get Reports
get
Get Report Status
get
Sync report types with default ones
post
Create Report Type
post
Get Report Types
get
Get Report Type by Id
get
Update a Report Type
put
Update a Report Type
del
Drawers
Get Sidedrawers by brand Code
get
Get Sidedrawer by id
get
Update Sidedrawer BrandCode, Region or Editable attributes
put
Delete Sidedrawer
del
Get Plan Requests for a given sidedrawer
get
Apply Sidedrawer template to Sidedrawer
put
Delete Sidedrawer External Key
del
Get Sidedrawers by brand Code
get
Signature
List Signature Templates
get
Get Signature Template by ID
get
Update Signature Template
put
Delete Signature Template
del
Tags
Create Tag
post
Get Tags
get
Update a Tag
put
Delete a Tag
del
Get a Tag by name
get
Move a Tag
put
Delete Tag references
del
Get autocomplete Tags
get
Teams
Get Teams for logged user
get
Get Teams available for a given user
get
Create Teams
post
Get Teams
get
Get Team by id
get
Update Teams
put
Delte Teams Members
del
Add accounts to Team
post
Get Teams Members
get
Delte Teams Members
del
Template Delivery
Create template delivery
post
Get template deliveries
get
Get template delivery
get
Delete template delivery
del
Get template delivery items
get
Get template delivery item
get
Templates
Create Sidedrawer Template
post
Get Sidedrawer templates
get
Delete Sidedrawer template
del
Timeline
Get Timeline
get
Get unread notifications count
get
Read all notifications
put
Get Tenant timeline
get
Get unread notifications count
get
Read all notifications
put
Customer Vaults
Create Vault with Enhanced Phone Number Support
post
List Vaults by Tenant
get
Update Tenant Vault
put
Delete Tenant Vault
del
Get Vault by ID
get
Add Sidedrawer to Tenant Vault
post
Create Sidedrawer Template
get
List Vault Sidedrawers
get
Create Sidedrawer and add to Vault
post
Delete Sidedrawer from Vault
del
List Vaults by OpenID
get
List Vaults by invitation code
get
List Vaults by Federation id
get
List Vaults by combination of external keys with optional user identifier and pagination
get
List Vaults by OpenID
get
List Vaults by invitation code
get
List Vaults by Federation id
get
Agreements
Create Agreement
post
Get Agreements
get
Update Agreement
put
Delete Agreement
del
Get specific agreement
get
Reminders
Create Reminders
post
Get Reminders
get
Update Reminder
put
Get Reminder
get
Delete Reminder
del
Update Reminder Status
put
Record Files
Get Record files
get
Update Record File
put
Remove Record File
del
Download Record File by fileToken
get
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
Powered by
Customer Vaults
Ask AI
