Hanzo
OpenapiCaptable

Returns the caller org's equity plans, newest first.

Returns the caller org's equity plans, newest first.

GET /v1/captable/plans

Addresshttps://api.hanzo.ai/v1/captable/plans
MethodGET
Operationget_captable_plans
AuthAuthorization: Bearer $HANZO_API_KEY

Returns the caller org's equity plans, newest first. An equity plan is an option pool: a reserve of shares, drawn from one share class, that option grants are written against.

Request

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

Response

StatusBodyMeaning
200captableEquityPlansok

200 body — 10 fields.

FieldInTypeAlwaysDescription
databodycaptableEquityPlan[]Data is every equity plan on the caller org's cap table, newest first.
data[].boardApprovalDatebodystringBoardApprovalDate is the ISO date the board approved the plan.
data[].commentsbodystringComments is free-form notes on the plan.
data[].createdAtbodyintegerCreatedAt is when the plan was recorded, in unix milliseconds.
data[].defaultCancellatonBehaviorbodystringDefaultCancellatonBehavior is what happens to cancelled grants, RETIRE or RETURN_TO_POOL.
data[].idbodystringID is the equity plan id.
data[].initialSharesReservedbodyintegerInitialSharesReserved is how many shares the plan reserves.
data[].namebodystringName is the plan name, e.g.
data[].planEffectiveDatebodystringPlanEffectiveDate is the ISO date the plan takes effect.
data[].shareClassIdbodystringShareClassID is the class the reserved shares come from.

Failure carries the platform error shape — see Errors.

Examples

hanzo captable plans get

Captable API · All Hanzo APIs · Interactive reference

How is this guide?

On this page