List links

Returns every live share link in the caller org's own store, newest first, with the controls a visitor will meet: whether an address is required, whether a password is set, the allow and deny lists, whether download is permitted, and when the link expires.

GET /v1/dataroom/links

Dataroom → · All API references → · Get started →

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

Archived links are omitted entirely. A link reports only THAT a password is set — the stored form is a bcrypt hash and no route returns it.

Request

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

Response

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

200 body — 15 fields.

Field	In	Type	Always	Description
`links`	body	dataroom.dataroomLink[]	—	Links is every non-archived link, newest first.
`links[].allowDownload`	body	boolean	—	AllowDownload is whether a visitor may download, rather than only view.
`links[].allowList`	body	string[]	—	AllowList narrows which addresses pass the email gate.
`links[].createdAt`	body	integer (int64)	—	CreatedAt is when the link was minted, in unix milliseconds.
`links[].dataroomId`	body	string	—	DataroomId is the room the link opens, null for a single-document link.
`links[].denyList`	body	string[]	—	DenyList rejects addresses, in the same three forms as the allow list, and is checked BEFORE it — so deny always wins.
`links[].documentId`	body	string	—	DocumentId is the document the link opens, null for a room link.
`links[].emailProtected`	body	boolean	—	EmailProtected is whether a visitor must state an address to enter.
`links[].expiresAt`	body	integer (int64)	—	ExpiresAt is when the link closes, in unix milliseconds; null never expires.
`links[].hasPassword`	body	boolean	—	HasPassword reports THAT a password is set.
`links[].id`	body	string	—	ID is the link id — the public token a visitor opens the room with.
`links[].isArchived`	body	boolean	—	IsArchived is whether the link has been retired.
`links[].linkType`	body	string	—	LinkType is DATAROOM_LINK or DOCUMENT_LINK.
`links[].name`	body	string	—	Name is the link's label, null when none was given.
`links[].updatedAt`	body	integer (int64)	—	UpdatedAt is when the link last changed, in unix milliseconds.

Failure carries the platform error shape — see Errors.

Examples

CLI

SDK

HTTP

MCP

hanzo dataroom links get

.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.getDataroomLinks();

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

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

resp, _, err := client.DataroomAPI.GetDataroomLinks(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_links(&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).getDataroomLinks();

curl https://api.hanzo.ai/v1/dataroom/links \
  -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?

PreviousList health NextGet file