Folders

Manage the dataroom folder tree. Folders organize documents and control visibility. See the Folder kind and Folder system role values in the overview.

List the folder tree

GET

/v1/folders

List the folder tree the caller can see: root folders with their children
expanded recursively.

Authorizations

HTTPBearer

Type

HTTP (bearer)

Responses

Successful Response

Content-Type

application/json

{

  

"can_write": false,

  

"created_at": "string",

  

"documents": [

  

  

{

  

  

  

"id": "string",

  

  

  

"name": "string"

  

  

}

  

],

  

"entity_missing": false,

  

"folders": [

  

  

{

  

  

}

  

],

  

"id": "string",

  

"kind": "string",

  

"name": "string",

  

"system_role": "string",

  

"updated_at": "string",

  

"visibility": "string"

}

Samples

Create a folder

POST

/v1/folders

Create a folder. Omit parent_id to create it at the root. Visibility follows
the same org / team / private scoping as other dataroom resources.

Authorizations

HTTPBearer

Type

HTTP (bearer)

Request Body

application/json

Min Length1

Format"uuid"

Responses

Successful Response

Content-Type

application/json

{

  

"created_at": "string",

  

"depth": 0,

  

"id": "string",

  

"kind": "string",

  

"name": "string",

  

"owner_team_id": "string",

  

"owner_user_id": "string",

  

"parent_id": "string",

  

"path": "string",

  

"system_role": "string",

  

"team_ids": [

  

  

"string"

  

],

  

"updated_at": "string",

  

"updated_by": "string",

  

"visibility": "string"

}

Samples

Delete a folder

DELETE

/v1/folders/{folder_id}

Delete a folder and every folder beneath it. The folders are marked deleted
and stop appearing in listings.

A folder still holding documents is rejected with 409 unless you send
cascade=true. With cascade the documents are deleted the same way
DELETE /documents/{document_id} deletes them — marked deleted, their files
retained — so cascading is not a way to erase content.

Authorizations

HTTPBearer

Type

HTTP (bearer)

Parameters

Path Parameters

folder_id*

Type

string

Required

Format

"uuid"

Query Parameters

cascade

Delete the documents in this folder tree as well. Required when the tree is not empty.

Type

boolean

Default

false

Responses

Successful Response

Samples

List folder contents

GET

/v1/folders/{folder_id}

List a folder's immediate children — subfolders and documents — as separate
folders and documents arrays. Not recursive.

Authorizations

HTTPBearer

Type

HTTP (bearer)

Parameters

Path Parameters

folder_id*

Type

string

Required

Format

"uuid"

Responses

Successful Response

Content-Type

application/json

{

  

"documents": [

  

  

{

  

  

  

"id": "string",

  

  

  

"name": "string"

  

  

}

  

],

  

"folders": [

  

  

{

  

  

  

"id": "string",

  

  

  

"kind": "string",

  

  

  

"name": "string",

  

  

  

"system_role": "string"

  

  

}

  

],

  

"id": "string",

  

"name": "string"

}

Samples

Update a folder

PATCH

/v1/folders/{folder_id}

Rename a folder or move it under a different parent. Only the fields present in
the request body are changed.

Authorizations

HTTPBearer

Type

HTTP (bearer)

Parameters

Path Parameters

folder_id*

Type

string

Required

Format

"uuid"

Request Body

application/json

Any of

Min Length1

Any of

Format"uuid"

Responses

Successful Response

Content-Type

application/json

{

  

"created_at": "string",

  

"depth": 0,

  

"id": "string",

  

"kind": "string",

  

"name": "string",

  

"owner_team_id": "string",

  

"owner_user_id": "string",

  

"parent_id": "string",

  

"path": "string",

  

"system_role": "string",

  

"team_ids": [

  

  

"string"

  

],

  

"updated_at": "string",

  

"updated_by": "string",

  

"visibility": "string"

}

Samples

Download folder contents as a zip archive

GET

/v1/folders/{folder_id}/download

Stream the folder's documents as a zip archive. The response is
application/zip with a Content-Disposition: attachment filename derived
from the folder name.

Authorizations

HTTPBearer

Type

HTTP (bearer)

Parameters

Path Parameters

folder_id*

Type

string

Required

Format

"uuid"

Query Parameters

include_subfolders

Include documents from all subfolders

Type

boolean

Default

false

Responses

Successful Response

Content-Type

[

]

Samples

Get folder details

GET

/v1/folders/{folder_id}/info

Get a single folder's own details, without listing what it contains.

Authorizations

HTTPBearer

Type

HTTP (bearer)

Parameters

Path Parameters

folder_id*

Type

string

Required

Format

"uuid"

Responses

Successful Response

Content-Type

application/json

{

  

"created_at": "string",

  

"depth": 0,

  

"id": "string",

  

"kind": "string",

  

"name": "string",

  

"owner_team_id": "string",

  

"owner_user_id": "string",

  

"parent_id": "string",

  

"path": "string",

  

"system_role": "string",

  

"team_ids": [

  

  

"string"

  

],

  

"updated_at": "string",

  

"updated_by": "string",

  

"visibility": "string"

}

Samples