OpenapiCaptable
Returns the caller org's equity plans, newest first.
Returns the caller org's equity plans, newest first.
GET /v1/captable/plans
| Address | https://api.hanzo.ai/v1/captable/plans |
| Method | GET |
| Operation | get_captable_plans |
| Auth | Authorization: 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
| Status | Body | Meaning |
|---|---|---|
200 | captableEquityPlans | ok |
200 body — 10 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
data | body | captableEquityPlan[] | — | Data is every equity plan on the caller org's cap table, newest first. |
data[].boardApprovalDate | body | string | — | BoardApprovalDate is the ISO date the board approved the plan. |
data[].comments | body | string | — | Comments is free-form notes on the plan. |
data[].createdAt | body | integer | — | CreatedAt is when the plan was recorded, in unix milliseconds. |
data[].defaultCancellatonBehavior | body | string | — | DefaultCancellatonBehavior is what happens to cancelled grants, RETIRE or RETURN_TO_POOL. |
data[].id | body | string | — | ID is the equity plan id. |
data[].initialSharesReserved | body | integer | — | InitialSharesReserved is how many shares the plan reserves. |
data[].name | body | string | — | Name is the plan name, e.g. |
data[].planEffectiveDate | body | string | — | PlanEffectiveDate is the ISO date the plan takes effect. |
data[].shareClassId | body | string | — | ShareClassID is the class the reserved shares come from. |
Failure carries the platform error shape — see Errors.
Examples
hanzo captable plans getimport { Configuration, CaptableApi } from 'hanzoai';
const api = new CaptableApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getCaptablePlans();from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import CaptableApi
client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = CaptableApi(client).get_captable_plans()cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)
resp, _, err := client.CaptableAPI.GetCaptablePlans(context.Background()).Execute()
if err != nil {
return err
}use hanzo_cloud::apis::{configuration::Configuration, captable_api};
let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();
let result = captable_api::get_captable_plans(&cfg, Default::default()).await?;import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.CaptableApi;
ApiClient client = new ApiClient();
client.setRequestInterceptor(b -> b.header("Authorization", "Bearer " + System.getenv("HANZO_API_KEY")));
var result = new CaptableApi(client).getCaptablePlans();curl https://api.hanzo.ai/v1/captable/plans \
-H "Authorization: Bearer $HANZO_API_KEY"The door reaches captable through the captable tool, which names its 31 operations with its own verbs — this one among them, under a name only the door declares. describe explains any of them:
curl -X POST https://api.hanzo.ai/v1/mcp \
-H "Content-Type: application/json" \
-d '{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "describe",
"arguments": {
"op": "list_captable_classes"
}
}
}'How is this guide?