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

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

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

Tenants Gateway

Tenants Endpoints
Tenant
- Retrieve an affiliate's (brand) Tenant Accountget
- List Tenants shared with youget
Messages
Subscriptions
Users
Invitations
Drawers
Teams
Templates
Webhooks
Reports
Collaborators
Filing Cabinets
Customer Vaults
Timeline
Health Check
- Health checkget

List a Hanger's (recordType) Collaborators (paginated)

get https://api-sbx.sidedrawersbx.com/api/v2/networks/sidedrawer/sidedrawer-id/{sidedrawerId}/groups

Provides the ability to add Collaborators to a specific Hanger (recordType) within a Drawer (sidedrawer), or to collaborate with an info request.

ℹ️
Versions
This endpoint also has a v1 version. Understand the difference here.

Path Params

sidedrawerId

string

required

Unique Drawer (sidedrawer) identifier.

Query Params

limit

string

Limit of number of returned objects per page. Default is 20.

startingAfter

string

An object ID that defines a list object's position in the list by identifying the list object(s) appearing before it.

endingBefore

string

An object ID that defines a list object's position in the list by identifying the list object(s) appearing after it.

Response

Response body

array of objects

object

sidedrawer

object

Drawer (sidedrawer) object.

sidedrawerRole

string

The User's role within the Drawer (sidedrawer). For example, "sd_editor".

record

object

Folder (record) object.

recordRole

string

The User's role within the Folder (record). For example, "rec_editor".

contributor

string

required

The contributor(s) with some level of access to the entity.

contributorType

string

required

The contributor type (Account, Team, Invitation).

account team invitation

relation

object

required

The contributor's relationship to the entity owner.

invitationCode

string

The Invitation code to the entity.

active

boolean

active = true if the entity has not been deleted.

Updated 10 months ago

List a Hanger's (recordType) Collaborators

Remove a Collaborator from a Hanger (recordType)

Did this page help you?

Language

Credentials

Bearer

JWT


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api-sbx.sidedrawersbx.com/api/v2/networks/sidedrawer/sidedrawer-id/sidedrawerId/groups \
3
     --header 'accept: application/json'


xxxxxxxxxx
54
]
1
[
2
  {
3
    "sidedrawer": {
4
      "id": "string",
5
      "name": "string",
6
      "description": "string",
7
      "firstName": "string",
8
      "lastName": "string",
9
      "default": true,
10
      "status": "ACTIVE",
11
      "userSidedrawerRole": [
12
        "string"
13
      ],
14
      "subscriptionFeatures": {}
15
    },
16
    "sidedrawerRole": "string",
17
    "record": {
18
      "id": "string",
19
      "name": "string",
20
      "description": "string",
21
      "uniqueReference": "string",
22
      "storageLocation": "string",
23
      "recordSubtypeName": "string",
24
      "recordSubtype": {},
25
      "recordSubtypeOther": "string",

Updated 10 months ago

List a Hanger's (recordType) Collaborators

Remove a Collaborator from a Hanger (recordType)

Did this page help you?

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

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

Getting Started
Access Token Generation
Versioning
Version Comparisons for Cabinets Endpoints
Permissions
Guides

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

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

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

ℹ️Versions

200Successfully retrieved Collaborators.

ℹ️
Versions