Hanzo
OpenapiDataroom

What a share link's visitor sees before authenticating

Answers the pre-auth face of a link to anyone holding its id: name and type, which gates apply (whether an address is required, whether a password is…

GET /v1/dataroom/view/{linkId}

Addresshttps://api.hanzo.ai/v1/dataroom/view/{linkId}
MethodGET
Operationget_dataroom_view_by_linkid
AuthAuthorization: Bearer $HANZO_API_KEY

Answers the pre-auth face of a link to anyone holding its id: name and type, which gates apply (whether an address is required, whether a password is set), whether download is permitted, whether it has expired, and the name and description of the room behind it — or, for a single-document link, that document's name and page count.

No principal is involved: the owning org is resolved from the link id through dataroom's one cross-tenant routing table, and an unknown or archived link is a 404.

It is metadata only — a room's document list and every file stay behind the authenticate step. An expired link is REPORTED as expired here rather than refused, so a visitor learns why the next step will fail; nothing about the password beyond its existence is disclosed.

Request

1 field.

FieldInTypeRequiredDescription
linkIdpathstringyes

Response

The document declares no response body for this operation. It answers 200 on success and the platform error shape on failure — see Errors.

Examples

hanzo dataroom view get <linkId>

Dataroom API · All Hanzo APIs · Interactive reference

How is this guide?

On this page