API Reference
Log In
API Reference

Collaborators

Collaborators are people or groups of people without a SideDrawer Account who are given a certain type of access (view, edit, etc.) to a Folder (record) or Drawer (sidedrawer).

When a Collaborator sets up a SideDrawer Account, more attributes besides the basic Collaborator attributes are attached to the entity.


Contributor Types (contributorType)

There are three main contributor "types":

  1. Account (account) – a User with a SideDrawer Account
  2. Team (team) – a group of Users
  3. Invitation (invitation) – someone who has not yet accepted an Invitation to create a SideDrawer Account

{
  "recordRole": "rec_viewer",
  "contributor": {
    "firstName": "Jane",
    "lastName": "Smith",
    "email": "[email protected]",
    "phone": "4161234567"
  },
  "contributorType": "account",
  "relation": {
    "personal": "other",
    "profession": "other",
    "professionOther": "attorney",
    "personalOther": "guardian"
  },
  "expiryDate": "2024-07-17T20:23:17.216Z"
}

Contributor (contributor) entity

firstName string
Contributor's first name.

lastName string
Contributor's last name.

email string required
Contributor's email address.

phone string
Contributor's phone number.


Relationship (relation) entity

personal enum
Contributor personal relationship by which to filter.
Possible values: spouse, partner, friend, sibling, child, grand_child, parent, grand_parent, in_law, relative, other.

profession enum
Contributor profession by which to filter.
Possible values: estate_lawyer, vip_client, client, lawyer, real_estate_agent, mortgage_broker, insurance_broker, investment_advisor, banking_relationship, manager, accountant, financial_planner, bookkeeper, executor, executor_advisor, sponsor, other, portfolio_manager.

professionOther string
Description of contributor's profession if profession = "other".

personalOther string
Description of contributor's personal relationship if personal = "other".