List datarooms

Returns every data room in the caller org's own store, newest first, with its short public id, name, description and timestamps.

GET /v1/dataroom/datarooms

Dataroom → · All API references → · Get started →

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

Returns every data room in the caller org's own store, newest first, with its short public id, name, description and timestamps.

Documents are not included — a room's contents come from reading the single room.

Request

GET /v1/dataroom/datarooms takes no parameters and no body — the credential is the whole request.

Response

Status	Body	Meaning
`200`	dataroom.dataroomRooms	ok
`default`	problem-details	refused

200 body — 7 fields.

Field	In	Type	Always	Description
`datarooms`	body	dataroom.dataroomRoom[]	—	Datarooms is every data room in the caller's own store, newest first.
`datarooms[].createdAt`	body	integer (int64)	—	CreatedAt is when the room was created, in unix milliseconds.
`datarooms[].description`	body	string	—	Description is the room's description, null when none was given.
`datarooms[].id`	body	string	—	ID is the room id, which is what other dataroom calls address it by.
`datarooms[].name`	body	string	—	Name is the room's display name.
`datarooms[].pId`	body	string	—	PId is the room's short public identifier, unique within the tenant.
`datarooms[].updatedAt`	body	integer (int64)	—	UpdatedAt is when the room last changed, in unix milliseconds.

Failure carries the platform error shape — see Errors.

Examples

CLI

SDK

HTTP

MCP

hanzo dataroom datarooms list

.ts

.py

.go

.rs

.java

import { Configuration, DataroomApi } from 'hanzoai';

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

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()

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

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

use hanzo_client::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(&cfg, Default::default()).await?;

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

ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));

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

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

MCP reaches dataroom through the dataroom tool, which names its 19 operations with its own verbs — this one among them, under a name only MCP 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

Was this page useful?

PreviousGet datarooms NextList file — GET /v1/dataroom/documents/{id}/file