# Get datarooms

URL: https://docs.hanzo.ai/docs/openapi/dataroom/get-dataroom-datarooms-by-id

> 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 →](https://docs.hanzo.ai/docs/openapi/dataroom) · [All API references →](https://docs.hanzo.ai/docs/openapi) · [Get started →](https://docs.hanzo.ai/docs/guides)

|               |                                                   |
| ------------- | ------------------------------------------------- |
| **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. |

## Response

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

`200` body — 19 fields.

| Field                                     | In   | Type                        | Always | Description                                                                                                  |
| ----------------------------------------- | ---- | --------------------------- | ------ | ------------------------------------------------------------------------------------------------------------ |
| `dataroom`                                | body | dataroom.dataroomRoomDetail | —      |                                                                                                              |
| `dataroom.createdAt`                      | body | integer (int64)             | —      | 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 | dataroom.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 (int64)             | —      | 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 (int64)             | —      | 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 (int64)             | —      | NumPages is the page count, null when it was not supplied at upload.                                         |
| `dataroom.documents[].orderIndex`         | body | integer (int64)             | —      | 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 (int64)             | —      | 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 (int64)             | —      | UpdatedAt is when the room last changed, in unix milliseconds.                                               |

Failure carries the platform error shape — see [Errors](https://docs.hanzo.ai/docs/errors).

## Examples

**CLI**

```bash
hanzo dataroom datarooms get <id>
```

**SDK**

**.ts**

```ts
import { Configuration, DataroomApi } from 'hanzoai';

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

**.py**

```python
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')
```

**.go**

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

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

**.rs**

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

**.java**

```java
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).getDataroomDataroomsById();
```

**HTTP**

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

**MCP**

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:

```bash
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](https://docs.hanzo.ai/docs/openapi/dataroom) · [All Hanzo APIs](https://docs.hanzo.ai/docs/openapi) · [Interactive reference](https://docs.hanzo.ai/docs/openapi/reference)
