Reads one of the caller org's data rooms together with every document in it,…

Reads one of the caller org's data rooms together with every document in it, each carrying its membership id and order index.

GET /v1/dataroom/datarooms/{id}

Dataroom → · All API references → · Six flows, four surfaces →


Address	`https://api.hanzo.ai/v1/dataroom/datarooms/{id}`
Method	`GET`
Operation	`get_dataroom_datarooms_by_id`
Auth	`Authorization: Bearer $HANZO_API_KEY`

Reads one of the caller org's data rooms together with every document in it, each carrying its membership id and order index.

The documents are sorted by that index with unordered ones last and creation time breaking ties — the SAME order a link's visitor sees, so this is what the room looks like from the outside. A room id outside the caller's own tenant store is not found.

Request

1 field.

Field	In	Type	Required	Description
`id`	path	string	yes	ID is the room to read. It is the path segment: the URL is the addressing authority, and the org it is resolved in comes from the caller's principal, so an id…

Response

Status	Body	Meaning
`200`	dataroomRoomDetailOne	ok

200 body — 19 fields.

Field	In	Type	Always	Description
`dataroom`	body	dataroomRoomDetail	—
`dataroom.createdAt`	body	integer	—	CreatedAt is when the room was created, in unix milliseconds.
`dataroom.description`	body	string	—	Description is the room's description, null when none was given.
`dataroom.documents`	body	dataroomMember[]	—	Documents is every document in the room, in the order a visitor sees them.
`dataroom.documents[].contentType`	body	string	—	ContentType is the mime type recorded at upload, null when none was sent.
`dataroom.documents[].createdAt`	body	integer	—	CreatedAt is when the document was uploaded, in unix milliseconds.
`dataroom.documents[].dataroomDocumentId`	body	string	—	DataroomDocumentId is the membership id — this document's place in THIS room, distinct from the document id.
`dataroom.documents[].fileKey`	body	string	—	FileKey is the opaque object-storage key the bytes are stored under.
`dataroom.documents[].fileSize`	body	integer	—	FileSize is the stored byte count, null when it was not recorded.
`dataroom.documents[].id`	body	string	—	ID is the document id.
`dataroom.documents[].name`	body	string	—	Name is the document's display name.
`dataroom.documents[].numPages`	body	integer	—	NumPages is the page count, null when it was not supplied at upload.
`dataroom.documents[].orderIndex`	body	integer	—	OrderIndex is the document's place in the viewer's list, null when it was added without one.
`dataroom.documents[].type`	body	string	—	Type is the document's kind, null when it was not recorded.
`dataroom.documents[].updatedAt`	body	integer	—	UpdatedAt is when the document row last changed, in unix milliseconds.
`dataroom.id`	body	string	—	ID is the room id.
`dataroom.name`	body	string	—	Name is the room's display name.
`dataroom.pId`	body	string	—	PId is the room's short public identifier.
`dataroom.updatedAt`	body	integer	—	UpdatedAt is when the room last changed, in unix milliseconds.

Failure carries the platform error shape — see Errors.

Examples

hanzo dataroom datarooms get <id>

import { Configuration, DataroomApi } from 'hanzoai';

const api = new DataroomApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getDataroomDataroomsById({ id: 'id' });

from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import DataroomApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = DataroomApi(client).get_dataroom_datarooms_by_id(id='id')

cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)

resp, _, err := client.DataroomAPI.GetDataroomDataroomsById(context.Background()).Execute()
if err != nil {
	return err
}

use hanzo_cloud::apis::{configuration::Configuration, dataroom_api};

let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();

let result = dataroom_api::get_dataroom_datarooms_by_id(&cfg, Default::default()).await?;

import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.DataroomApi;

ApiClient client = new ApiClient();
client.setRequestInterceptor(b -> b.header("Authorization", "Bearer " + System.getenv("HANZO_API_KEY")));

var result = new DataroomApi(client).getDataroomDataroomsById();

curl https://api.hanzo.ai/v1/dataroom/datarooms/<id> \
  -H "Authorization: Bearer $HANZO_API_KEY"

The door reaches dataroom through the dataroom tool, which names its 17 operations with its own verbs — this one among them, under a name only the door declares. describe explains any of them:

curl -X POST https://api.hanzo.ai/v1/mcp \
  -H "Content-Type: application/json" \
  -d '{
       "jsonrpc": "2.0",
       "id": 1,
       "method": "tools/call",
       "params": {
         "name": "describe",
         "arguments": {
           "op": "get_dataroom_analytic_dataroom"
         }
       }
     }'

Dataroom API · All Hanzo APIs · Interactive reference

Reads one of the caller org's data rooms together with every document in it,…

Request

Response

Examples

On this page