Introduction

The Data Room (DR) APIs provide a structured and secure way to manage and access documents, permissions, and collaboration features within a virtual data room. These APIs enable seamless integration with external systems, ensuring efficient data exchange, granular access control, and real-time collaboration capabilities.

Key Functionalities Supported by the API

1. Document & File Management

Upload, retrieve, update, and delete files.
Organize files within folders for structured storage.
Create, rename, move, and delete folders.
Maintain a hierarchical structure for easy navigation.

2. User & Access Control

Manage user roles and permissions for secure access.
Create and manage user groups with shared access rights.

3. User Invitation & Onboarding

Invite new users to the data room via email.
Assign roles and permissions upon invitation.

4. Insights & Reporting

Generate insights on document access, user engagement, and trends.

5. Notifications & Event Triggers

Notify users of document changes, comments, and access updates.
Support webhook integrations for real-time event tracking.

Core API Objects

The DR APIs are built around key objects representing different data room components. These objects enable structured data management and ensure smooth interaction with the API.

1. Data room Object

Represents the virtual data room that contains files, folders, users, and insights.

Field Name	Data Type	Field Description
id	string	Unique identifier of the data room.
name	string	Name of the data room.
organization	string	Name of the organization to which the data room belongs.
createdAt	timestamp	Timestamp when the data room was created.

2. Folder Object

Represents a folder that organizes files within a data room.

Field Name	Data Type	Field Description
id	string	Unique identifier of the folder.
name	string	Folder name.
dataroomId	string	ID of the data room that contains the folder.
createdAt	timestamp	Timestamp when the folder was created.
updatedAt	timestamp	Last modified timestamp.

3. File Object

Represents an individual file stored in a folder within the data room.

Field Name	Data Type	Field Description
id	string	Unique identifier of the file.
name	string	File name.
folderId	string	ID of the folder containing the file.
dataroomId	string	ID of the data room that contains the file.
size	integer	File size in bytes.
createdAt	timestamp	Timestamp when the file was uploaded.
uploader	string	Email of the uploader.

4. User Object

Field Name	Data Type	Field Description
firstName	string	User’s first name.
lastName	string	User's last name.
email	string	Email address of the user.
role	string	User’s role in the data room (`admin`, `member`, `contributor`, `observer`).
status	string	User status (`joined`, `pending invitation`).

5. User Group Object

Field Name	Data Type	Field Description
id	string	Unique identifier of the user group.
name	string	Name of the user group.
dataroomId	string	ID of the data room associated with the group.
users	array	List of user emails in the group.
role	array	Role of the group (`admin`, `member`, `contributor`, `observer`).
createdAt	timestamp	Timestamp when the group was created.

6. Insights

Represents analytical insights about the data room’s activity, such as user engagement and file interactions.