Hanzo
OpenapiDataroom

Answers the caller org's OWN trust centre: its settings, every item it holds in…

Answers the caller org's OWN trust centre: its settings, every item it holds in both tiers, the requests waiting on it, and the grants it has made.

GET /v1/dataroom/trust

Addresshttps://api.hanzo.ai/v1/dataroom/trust
MethodGET
Operationget_dataroom_trust
AuthAuthorization: Bearer $HANZO_API_KEY

Answers the caller org's OWN trust centre: its settings, every item it holds in both tiers, the requests waiting on it, and the grants it has made.

The org is the caller's, taken from the validated bearer and from nothing else, so this op cannot be pointed at another tenant — there is no field for one. An org that has never opened a centre reads back an empty one rather than an error, because having no trust centre is an ordinary state and this is the read that tells you so.

Request

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

Response

StatusBodyMeaning
200trustDeskok

200 body — 37 fields.

FieldInTypeAlwaysDescription
grantsbodytrustGrantView[]Grants is every grant that has been made, newest first.
grants[].emailbodystringEmail is the one address the link admits.
grants[].expiresAtbodyintegerExpiresAt is when the grant closes, in unix milliseconds.
grants[].itembodystringItem is the item granted, empty when the whole released tier was granted.
grants[].linkbodystringLink is the share link's id — the token the party opens.
grants[].livebodybooleanLive is whether the grant is still open at the time of reading.
itemsbodytrustItemView[]Items is everything the org holds, both tiers, retired included.
items[].attesterbodystringAttester is who vouched for it: self or auditor.
items[].bodybodystringBody is the item's content for the kinds that are text rather than a file.
items[].createdAtbodyintegerCreatedAt is when it was published, in unix milliseconds.
items[].documentbodystringDocument is the data-room document holding its bytes, empty when it has none.
items[].frameworkbodystringFramework is the standard it speaks to, when it speaks to one.
items[].idbodystringID addresses the item.
items[].kindbodystringKind is what it is.
items[].namebodystringName is its title.
items[].retiredbodybooleanRetired is whether it has been withdrawn. A retired item is absent from the public centre and cannot be granted; it is kept because a grant already made over…
items[].summarybodystringSummary is a line about it.
items[].tierbodystringTier is public or gated.
items[].updatedAtbodyintegerUpdatedAt is when it last changed, in unix milliseconds.
namebodystringName is the centre's display name.
ndabodystringNda is the text a party must accept before asking.
publishedbodybooleanPublished is whether the centre answers at its public address.
requestsbodytrustAskView[]Requests is every ask, newest first, open ones included.
requests[].createdAtbodyintegerCreatedAt is when the ask arrived, in unix milliseconds.
requests[].decidedAtbodyintegerDecidedAt is when it was answered, in unix milliseconds; 0 while open.
requests[].decidedBybodystringDecidedBy is who answered it.
requests[].emailbodystringEmail is the address that asked, as stated and UNVERIFIED — it names a party and proves nothing, which is why the grant is addressed to it rather than trusting…
requests[].expiresAtbodyintegerExpiresAt is when a granted ask closes, in unix milliseconds.
requests[].idbodystringID is the request's id.
requests[].itembodystringItem is the item asked for, empty when the whole released tier was asked for.
requests[].linkbodystringLink is the share link a granted ask became.
requests[].ndabodystringNda is the text this party accepted, verbatim as it stood when they accepted.
requests[].notebodystringNote is what the decider wrote when refusing.
requests[].partybodystringParty is the company the asker stated.
requests[].reasonbodystringReason is why they said they want it.
requests[].statebodystringState is open, granted or refused.
slugbodystringSlug is the public address, empty until the centre is published.

Failure carries the platform error shape — see Errors.

Examples

hanzo has no subcommand for this operation — the CLI serves only what cloud's live route table confirms. Use HTTP or an SDK.


Dataroom API · All Hanzo APIs · Interactive reference

How is this guide?

On this page