Hanzo
OpenapiCaptable

Returns the caller org's cap-table company record.

Returns the caller org's cap-table company record.

GET /v1/captable/company

Addresshttps://api.hanzo.ai/v1/captable/company
MethodGET
Operationget_captable_company
AuthAuthorization: Bearer $HANZO_API_KEY

Returns the caller org's cap-table company record. The row is seeded when the tenant's store first opens, so it always exists; its name and incorporation details are set with PUT /v1/captable/company.

Request

GET /v1/captable/company takes no parameters and no body — the credential is the whole request.

Response

StatusBodyMeaning
200captableCompanyok

200 body — 8 fields.

FieldInTypeAlwaysDescription
createdAtbodyintegerCreatedAt is when the company row was seeded, in unix milliseconds.
idbodystringID is the company id, which is the tenant's own org id.
incorporationCountrybodystringIncorporationCountry is the ISO country the entity is incorporated in.
incorporationStatebodystringIncorporationState is the state or province of incorporation.
incorporationTypebodystringIncorporationType is the entity kind, e.g.
namebodystringName is the company's legal name.
publicIdbodystringPublicID is the company's shareable public identifier.
updatedAtbodyintegerUpdatedAt is when the company row last changed, in unix milliseconds.

Failure carries the platform error shape — see Errors.

Examples

hanzo captable company get

Captable API · All Hanzo APIs · Interactive reference

How is this guide?

On this page