Returns every document in the caller org's own store, newest first — name,…
Returns every document in the caller org's own store, newest first — name, opaque storage key, content type, page count, size and timestamps.
GET /v1/dataroom/documents
| Address | https://api.hanzo.ai/v1/dataroom/documents |
| Method | GET |
| Operation | get_dataroom_documents |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Returns every document in the caller org's own store, newest first — name, opaque storage key, content type, page count, size and timestamps.
Tenant isolation is the per-org store itself: there is one SQLite file per org and the org is never a parameter, so no input the caller controls can address another tenant's documents. Metadata only — the bytes come from the file route.
Request
GET /v1/dataroom/documents takes no parameters and no body — the credential is the whole request.
Response
| Status | Body | Meaning |
|---|---|---|
200 | dataroomDocuments | ok |
200 body — 10 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
documents | body | dataroomDocument[] | — | Documents is every document in the caller's own store, newest first. |
documents[].contentType | body | string | — | ContentType is the mime type recorded at upload, null when none was sent. |
documents[].createdAt | body | integer | — | CreatedAt is when the document was uploaded, in unix milliseconds. |
documents[].fileKey | body | string | — | FileKey is the opaque object-storage key the bytes are stored under. |
documents[].fileSize | body | integer | — | FileSize is the stored byte count, null when it was not recorded. |
documents[].id | body | string | — | ID is the document id. |
documents[].name | body | string | — | Name is the document's display name. |
documents[].numPages | body | integer | — | NumPages is the page count, null when it was not supplied at upload. |
documents[].type | body | string | — | Type is the document's kind, null when it was not recorded. |
documents[].updatedAt | body | integer | — | UpdatedAt is when the document row last changed, in unix milliseconds. |
Failure carries the platform error shape — see Errors.
Examples
hanzo dataroom documents listimport { Configuration, DataroomApi } from 'hanzoai';
const api = new DataroomApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getDataroomDocuments();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_documents()cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)
resp, _, err := client.DataroomAPI.GetDataroomDocuments(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_documents(&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).getDataroomDocuments();curl https://api.hanzo.ai/v1/dataroom/documents \
-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"
}
}
}'How is this guide?