Hanzo
OpenapiDataroom

Returns every data room in the caller org's own store, newest first, with its…

Returns every data room in the caller org's own store, newest first, with its short public id, name, description and timestamps.

GET /v1/dataroom/datarooms

Addresshttps://api.hanzo.ai/v1/dataroom/datarooms
MethodGET
Operationget_dataroom_datarooms
AuthAuthorization: Bearer $HANZO_API_KEY

Returns every data room in the caller org's own store, newest first, with its short public id, name, description and timestamps.

Documents are not included — a room's contents come from reading the single room.

Request

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

Response

StatusBodyMeaning
200dataroomRoomsok

200 body — 7 fields.

FieldInTypeAlwaysDescription
dataroomsbodydataroomRoom[]Datarooms is every data room in the caller's own store, newest first.
datarooms[].createdAtbodyintegerCreatedAt is when the room was created, in unix milliseconds.
datarooms[].descriptionbodystringDescription is the room's description, null when none was given.
datarooms[].idbodystringID is the room id, which is what other dataroom calls address it by.
datarooms[].namebodystringName is the room's display name.
datarooms[].pIdbodystringPId is the room's short public identifier, unique within the tenant.
datarooms[].updatedAtbodyintegerUpdatedAt is when the room last changed, in unix milliseconds.

Failure carries the platform error shape — see Errors.

Examples

hanzo dataroom datarooms list

Dataroom API · All Hanzo APIs · Interactive reference

How is this guide?

On this page