Dataroom

Package dataroom is a secure document room you share by link and watch page by page.

Guide & examples → · All API references → · Six flows, four surfaces →


Base URL	`https://api.hanzo.ai`
Operations	17
Auth	`Authorization: Bearer $HANZO_API_KEY`

get_v1_dataroom_analytics_dataroom_by_dataroomid

GET /v1/dataroom/analytics/dataroom/{dataroomId}

Parameter	In	Type	Required	Description
`dataroomId`	path	string	yes

get_v1_dataroom_analytics_link_by_linkid

GET /v1/dataroom/analytics/link/{linkId}

Parameter	In	Type	Required	Description
`linkId`	path	string	yes

post_v1_dataroom_datarooms_by_id_documents

POST /v1/dataroom/datarooms/{id}/documents

Parameter	In	Type	Required	Description
`id`	path	string	yes

get_v1_dataroom_datarooms_by_id

GET /v1/dataroom/datarooms/{id}

Parameter	In	Type	Required	Description
`id`	path	string	yes

get_v1_dataroom_datarooms

GET /v1/dataroom/datarooms

post_v1_dataroom_datarooms

POST /v1/dataroom/datarooms

get_v1_dataroom_documents_by_id_file

GET /v1/dataroom/documents/{id}/file

Parameter	In	Type	Required	Description
`id`	path	string	yes

get_v1_dataroom_documents_by_id

GET /v1/dataroom/documents/{id}

Parameter	In	Type	Required	Description
`id`	path	string	yes

get_v1_dataroom_documents

GET /v1/dataroom/documents

post_v1_dataroom_documents

POST /v1/dataroom/documents

get_v1_dataroom_health

GET /v1/dataroom/health

get_v1_dataroom_links

GET /v1/dataroom/links

post_v1_dataroom_links

POST /v1/dataroom/links

post_v1_dataroom_view_by_linkid_authenticate

POST /v1/dataroom/view/{linkId}/authenticate

Parameter	In	Type	Required	Description
`linkId`	path	string	yes

get_v1_dataroom_view_by_linkid_document_by_documentid_file

GET /v1/dataroom/view/{linkId}/document/{documentId}/file

Parameter	In	Type	Required	Description
`linkId`	path	string	yes
`documentId`	path	string	yes

post_v1_dataroom_view_by_linkid_pageview

POST /v1/dataroom/view/{linkId}/pageview

Parameter	In	Type	Required	Description
`linkId`	path	string	yes

get_v1_dataroom_view_by_linkid

GET /v1/dataroom/view/{linkId}

Parameter	In	Type	Required	Description
`linkId`	path	string	yes

Dataroom guide · All Hanzo APIs · Interactive reference

Dataroom

On this page