JUMP TOOverviewSideDrawerOur API Design & ProtocolUsing the SideDrawer APIsHTTP Methods and Response CodesFilteringPaginationDefinitionsSideDrawer StructureGlossaryMetadataEntitiesCollaboratorsFiling CabinetsDrawersHangersFoldersRecord SubtypesRecord Subtype Specific FieldsFilesNotificationsRemindersAccountsPlan RequestsSubscriptionsSubscription FeaturesReportsSignaturesCloud StorageSmart Forms RequestsTenantsUser RolesTeam RolesMessagesBrandingPlansFieldsTemplatesIntegrationsWebhooksCustomer VaultsSmart FormsGetting StartedAccess Token GenerationAccess Token for ProductionpostAccess Token for Testing PurposespostVersioningVersion Comparisons for Cabinets EndpointsPermissionsGuidesCabinets GatewayCabinets EndpointsCollaboratorsDrawer CollaboratorsList all Drawers (sidedrawer) shared with yougetList all of your owned Drawers (sidedrawer)getList all template Drawers (sidedrawer)getAdd a Collaborator to a Drawer (sidedrawer)postRemove a Collaborator from a Drawer (sidedrawer)deleteTransfer ownership of a Drawer (sidedrawer) to another UserpostUpdate a Drawer (sidedrawer) CollaboratorputRemove a Collaborator from a Drawer (sidedrawer) using the networkIddeleteList all Drawers (sidedrawer) shared with you (paginated)getList Drawers (sidedrawer) you have access to (lite)getList all of your owned Drawers (sidedrawer) (paginated)getAdd a Collaborator (including a Team) to a Drawer (sidedrawer)postList all template Drawers (sidedrawer) (paginated)getFolder (Record) CollaboratorsAdd a Collaborator to a Folder (record)postRemove a Collaborator from a Folder (record)deleteUpdate a Folder (record) CollaboratorputRemove a Collaborator from a Folder (record) using the networkIddeleteAdd a Collaborator (including a Team) to a Folder (record)postList a Folder's (record) CollaboratorsgetHanger (Tile) CollaboratorsAdd a Collaborator for a Hanger (recordType)postList a Hanger's (recordType) CollaboratorsgetList a Hanger's (recordType) Collaborators (paginated)getRemove a Collaborator from a Hanger (recordType)deleteGeneralList CollaboratorsgetList active CollaboratorsgetList inactive Collaborators (Invitees)getList "Team"-type CollaboratorsgetList your TeamsgetList Collaborators (paginated)getList a Drawer's (sidedrawer) or Folder's (record) CollaboratorsgetFolders (Records)List a Drawer's (sidedrawer) Folders (record) (paginated)getUpdate a Folder (record)putDelete a Folder (record)deleteRetrieve a Folder (record)getCreate a Folder (record)postList a Drawer's (sidedrawer) Folders (record)getMove a Folder (record)putCopy a Folder (record)putSet Folders (record) as "related"postRetrieve a Folder's (record) related Folders (record)getRemove a Folder (record) as "related" to anotherdeleteDrawersCreate a Drawer (sidedrawer) for a free SubscriptionpostList a Brand's Drawer (sidedrawer) typesgetUpdate a Drawer (sidedrawer)putDelete a Drawer (sidedrawer)deleteRetrieve a Drawer (sidedrawer)getApply a template to a Drawer (sidedrawer)putRetrieve a Drawer's (sidedrawer) brandinggetRetrieve information about a Drawer (sidedrawer)getRetrieve information (lite) about a Drawer (sidedrawer)getRetrieve a Drawer's (sidedrawer) licensegetList all files within a Drawer (sidedrawer)getList all files from cloud storagegetRetrieve a Filing Cabinet's Drawers (sidedrawer)getFilesCreate a fileCreate a filepostCreate file(s)postList a Folder's (record) filesList a Folder's (record) filesgetList a Folder's (record) files (paginated)getUpdate a fileUpdate a file (using the file name and extension)putUpdate a file (using the file token)putDownload a fileDownload a file (using the file name and extension)getDownload a file (using the file token)getDelete a fileDelete a file (using the file name and extension)deleteDelete a file (using the file token)deleteSeal a fileSeal a file (using the file name and extension)putSeal a file (using the file token)putSend a file to quarantineSend a file to quarantine (using the file name and extension)postSend a file to quarantine (using the file token)postRetrieve a file's metadataRetrieve a file's metadatagetRetrieve a file's metadata (using the file token)getCopy a fileputMove a fileputDownload a file by stream (using the file token)getRemindersCreate a ReminderpostList an entity's RemindersgetUpdate a ReminderputRetrieve a RemindergetDelete a ReminderdeleteUpdate a Reminder's statusputHangers (Tiles)List Hangers (recordType)getList Record SubtypesgetList a Record Subtype's Specific FieldsgetNotificationsRetrieve a Drawer's (sidedrawer) timelinegetRetrieve a Drawer's (sidedrawer) logged eventsgetRetrieve a Drawer's (sidedrawer) timeline (paginated)getRetrieve a Drawer's (sidedrawer) detailed timelinegetRetrieve number of unread Drawer (sidedrawer) timeline notificationsgetMark a Drawer's (sidedrawer) notifications as "read"putAccountsRetrieve an Account's settingsgetUpdate an Account's settingsputCreate an AccountpostCreate an InvitationpostRetrieve an AccountgetUpdate an AccountputDelete an Account (admin rights needed)deleteList an Account's TeamsgetRetrieve an Account by usernamegetRetrieve an Account by OpenIDgetLog out of AccountdeleteCreate an InvitationpostAdd an email address to an AccountpostRemove an email address from an AccountdeleteAdd a phone number to an AccountpostRemove a phone number from an AccountdeleteAccept Account agreementspostList the Account agreementsgetCreate an MFA codepostValidate an MFA codegetList all of a User's Filing CabinetsgetList all of a Filing Cabinet's Drawers (sidedrawer)getPlan RequestsList a Drawer's (sidedrawer) available PlansgetList a Drawer's (sidedrawer) available Plans (paginated)getCreate a Plan RequestpostList a Drawer's (sidedrawer) Plan RequestsgetDelete a Plan RequestdeleteList a Plan Request's ItemsgetConsolidate Items into a Plan RequestpostUpdate a Plan Request ItemputDelete a Plan Request ItemdeleteSubscriptionsCreate a SubscriptionpostRetrieve a Subscription's tax informationgetRetrieve the available SubscriptiongetDelete a SubscriptiondeleteCreate a Drawer (sidedrawer) from a SubscriptionpostCreate a Customer profile for the current UserpostRetrieve Customer information (using the email address)getRetrieve Customer information (using the customerId)getAdd a payment method to a CustomerpostList a Customer's payment methodsgetSet a payment method as the defaultputDetach a payment method from a Customer's profiledeleteRetrieve a Customer's available SubscriptionsgetRetrieve the current User's available SubscriptionsgetRetrieve the available Subscriptions and pricesgetRetrieve a Subscription's informationgetCalculate a Subscription pricegetAssign a license to a Drawer (sidedrawer)postList available licensesgetDetach a license from a Drawer (sidedrawer)deleteIncrease the number of licensesputDecrease the number of licensesputSend a sponsored Invitation to SideDrawerpostList available licenses (paginated)getRetrieve a Drawer's (sidedrawer) featuresgetRetrieve a Customer's featuresgetReportsCreate a Report for a Drawer (sidedrawer)postList a Drawer's (sidedrawer) ReportsgetRetrieve a Report's statusgetList a Drawer's (sidedrawer) Report typesgetSignaturesList a Drawer's (sidedrawer) templatesgetRetrieve a templategetCreate a signature from a templatepostList a Folder's (record) EnvelopesgetRetrieve an EnvelopegetCloud StorageList available IntegrationsgetRetrieve a Drawer's (sidedrawer) cloud drivesgetRetrieve a cloud drive's root contentgetRetrieve a Folder's (record) cloud content.getUpload a cloud folder to a SideDrawer Folder (record)postDelete a cloud folder from a SideDrawer Folder (record)deleteUpload a cloud file to a SideDrawer Folder (record)postDelete a cloud file from a SideDrawer Folder (record)deleteFiling CabinetsCreate a Filing CabinetpostList the current User's Filing CabinetsgetRetrieve a Filing CabinetgetUpdate a Filing CabinetputDelete a Filing CabinetdeleteAdd a Drawer (sidedrawer) to a Filing CabinetpostRetrieve a Drawer (sidedrawer) from a Filing CabinetgetRemove a Drawer (sidedrawer) from a Filing CabinetdeleteList a Filing Cabinet's Drawers (sidedrawer)getCreate a Filing Cabinet for a Drawer (sidedrawer)postList a User's Filing CabinetsgetCreate a Filing Cabinet for an Invitee's Drawer (sidedrawer)postRetrieve a Drawer's (sidedrawer) Filing CabinetsgetList an Invitee's Filing CabinetsgetSmart Forms RequestList the available Smart FormsgetCreate a Smart FormpostRetrieve a Drawer's (sidedrawer) Smart Form requestsgetRetrieve a Smart Form requestgetDelete a Smart Form requestdeleteCreate a Smart Form request rolepostDelete a Smart Form request roledeleteCreate a Smart Form screen namepostList Smart Form screen namesgetCreate a Smart Form section namepostList Smart Form section namesgetDelete a Smart Form section namedeleteBlocks GatewayBlocks EndpointsBlocksUpload individual or multiple BlockspostDownload multiple BlockspostDownload filesgetDownload files by streamgetHealth CheckHealth checkgetSignaturesRetrieve all document metadatagetRetrieve a document's metadatagetCloud StorageGet a cloud folder's contentgetAggregatorsDownload an aggregator filegetTenants GatewayTenants EndpointsTenantRetrieve an affiliate's (brand) Tenant AccountgetList Tenants shared with yougetMessagesSync default system MessagespostCreate a new MessagepostList MessagesgetList Messages of a certain typegetUpdate a Message templateputDelete a Message templatedeleteSubscriptionsCreate a SubscriptionpostList a Customer's available SubscriptionsgetCreate a Drawer (sidedrawer) from a Subscription (sends Invitation where applicable)postCreate a Drawer (sidedrawer) from a SubscriptionpostIncrease the number of licensesputDecrease the number of licensesputUsersCreate Tenant UserspostRetrieve an affiliate's (brand) or Sponsorship's User AccountgetRetrieve a User Account (using the OpenID)getRetrieve a User Account (using the username)getRetrieve a User Account (using the branding or sponsorship)getList a User's Drawers (sidedrawer) and Folders (record)getInvitationsCreate an InvitationpostList sent InvitationsgetList pending sponsored InvitationsgetRetrieve a sent InvitationgetDelete an InvitationdeleteResend an Invitation emailpostSearch Pending Sponsored InvitationsgetList sent Invitations (paginated)getDrawersUpdate a Drawer's (sidedrawer) affiliate code (brandCode), region or other editable attributesputDelete a Drawer (sidedrawer)deleteList a Drawer's (sidedrawer) Plan RequestsgetDelete an external key from a Drawer (sidedrawer)deleteList an affiliate's (brand) Drawers (sidedrawer)getTeamsList your TeamsgetList a User's TeamsgetCreate a TeampostList a Tenant's TeamsgetRetrieve a TeamgetUpdate a TeamputRemove a Team memberdeleteAdd a member to a TeampostList a Team's membersgetRemove a Team memberdeleteTemplatesCreate a Drawer (sidedrawer) TemplatepostList Drawer (sidedrawer) TemplatesgetDelete a Drawer (sidedrawer) TemplatedeleteWebhooksCreate a Webhook subscriptionpostList Webhook subscriptionsgetRetrieve a Webhook loggetUpdate a Webhook subscriptionputRetrieve a Webhook subscriptiongetDelete a Webhook subscriptiondeleteReportsCreate a Report requestpostList ReportsgetRetrieve a Report's statusgetCollaboratorsAdd a Collaborator to a Drawer (sidedrawer)postList a Drawer's (sidedrawer) CollaboratorsgetRemove a Drawer (sidedrawer) CollaboratordeleteAdd a Collaborator to a Drawer (sidedrawer)postList a Drawer's (sidedrawer) CollaboratorsgetFiling CabinetsRetrieve a Drawer's (sidedrawer) Filing CabinetgetList a Filing Cabinet's Drawers (sidedrawer)getList a User's Filing CabinetsgetList a User's Filing Cabinet's Drawers (sidedrawer)getList an enterprise's Filing CabinetsgetList an enterprise's Filing Cabinet's Drawers (sidedrawer)getList an Invitee's Filing CabinetsgetList an Invitee's Filing Cabinet's Drawers (sidedrawer)getCustomer VaultsCreate a VaultpostList a Tenant's VaultsgetUpdate a VaultputDelete a VaultdeleteRetrieve a VaultgetAdd a Drawer (sidedrawer) to a VaultpostCreate a Drawer (sidedrawer) TemplategetCreate a Drawer (sidedrawer) in a VaultpostRemove a Drawer (sidedrawer) from a VaultdeleteTimelineRetrieve a Tenant's TimelinegetRetrieve a Tenant's count of unread notificationsgetMark all notifications as "read"putHealth CheckHealth checkgetMetadataSome entities, such as files (recordFile), Folders (record) and Drawers (sidedrawer), have an externalKeys parameter that accepts metadata in the form of key-value data. This can be used to add more information about an entity.
