For AI agents: visit https://sidedrawer.readme.io/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI. Append .md to any documentation page URL to get its markdown version.

API Reference

v1.0

Log In

API Reference

Log In

v1.0API Reference

Overview

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

Definitions

SideDrawer Structure
Glossary
Metadata
Entities

Getting Started

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

Cabinets Gateway

Collaborators
Folders (Records)
Drawers (Sidedrawers)
Files
Reminders
Tiles (Hangers)
Notifications
Accounts
Plan Requests
Subscriptions
Reports
Signatures
Cloud Storage
Filing Cabinets
Smart Forms Request
Network
- Get Networkget

Tenants Gateway

Workflow Automations
Webhooks
Branding
Comments
Marketplace - OAuth Configuration
- Generate OAuth consent URLget
- Complete OAuth authorizationget
Marketplace - Export/Import
- Export Marketplace Configurationget
- Import Marketplace Configurationpost
Connections
Subscriptions
Record Types
Users
Invitations
File Delivery
Tenant
User Roles
Teams Roles
Applications
Applications Login
Federation Groups
Files
Filing Cabinets
Integrations Config
- generate consent for providerget
- Endpoint requeste when the consent is givenget
Integrations
Key Delivery
Marketplace - Connections
Marketplace - Requests
Sidedrawer Networks
Messages
Plans
Plan Requests
- Update Plan Requestput
Aggregators
Aggregators Delivery
Record SubTypes
Record SubTypes specific fields
Smart Forms
Reports
Drawers
Signature
Tags
Teams
Template Delivery
Templates
Timeline
Customer Vaults
Agreements
Reminders
Record Files

Blocks Gateway

Blocks Endpoints
Blocks
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

Powered by

External Keys

`ExternalKeys` entity

key

string

required

External key.

value

string

External key value.

Updated 10 months ago

Error Responses

Federation Groups

Did this page help you?

Updated 10 months ago

Error Responses

Federation Groups

Did this page help you?

- ExternalKeys entity

ExternalKeys entity

`ExternalKeys` entity