These docs are for v1.0. Click to read the latest docs for v2.0.

Board User Connection Object

The Board User Connection object defines a relationship between the user and the board. The user has different permissions on the board depending on their role.

Collaboration object will be created when you use Share Board.

type
string
board-user-connection
id
string
Unique identifier for the object
user
Mini User Object
The user that is granted access
role
string
Value can be viewer, commenter, editor, owner
createdAt
date-time
When the connection was created
modifiedAt
date-time
When the connection was modified. If it has not been modified, this field is equal to createdAt
createdBy
Mini User Object
The user who created this connection
modifiedBy
Mini User Object
The user who modified this connection. If it has not been modified, this field is equal to createdBy
{  
   "type":"board-user-connection",
   "id":"645326342",
   "role":"viewer",
   "user": {
       "type":"user",
       "id":"75422345",
       "name":"Some User"
   }
}