OpenapiCaptable
Returns the caller org's option grants, newest first.
Returns the caller org's option grants, newest first. Each row is joined to its grantee and its equity plan.
GET /v1/captable/options
| Address | https://api.hanzo.ai/v1/captable/options |
| Method | GET |
| Operation | get_captable_options |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Returns the caller org's option grants, newest first. Each row is joined to its grantee and its equity plan. Grants that are EXERCISED, EXPIRED or CANCELLED are listed here but do not dilute the cap table.
Request
GET /v1/captable/options takes no parameters and no body — the credential is the whole request.
Response
| Status | Body | Meaning |
|---|---|---|
200 | captableOptions | ok |
200 body — 15 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
data | body | captableOption[] | — | Data is every option grant, newest first. |
data[].cliffYears | body | integer | — | CliffYears is how many years before any of the grant vests. |
data[].equityPlanId | body | string | — | EquityPlanID is the plan the grant draws from. |
data[].equityPlanName | body | string | — | EquityPlanName is that plan's name. |
data[].exercisePrice | body | number | — | ExercisePrice is the strike price per share. |
data[].expirationDate | body | string | — | ExpirationDate is the ISO date the grant expires. |
data[].grantId | body | string | — | GrantID is the grant number, unique within the company. |
data[].id | body | string | — | ID is the option id. |
data[].issueDate | body | string | — | IssueDate is the ISO date the grant was issued. |
data[].quantity | body | integer | — | Quantity is how many shares the grant covers. |
data[].stakeholderId | body | string | — | StakeholderID is the grantee. |
data[].stakeholderName | body | string | — | StakeholderName is that grantee's name. |
data[].status | body | string | — | Status is the grant's state, e.g. |
data[].type | body | string | — | Type is the grant kind, ISO or NSO. |
data[].vestingYears | body | integer | — | VestingYears is the total vesting period in years. |
Failure carries the platform error shape — see Errors.
Examples
hanzo captable options listimport { Configuration, CaptableApi } from 'hanzoai';
const api = new CaptableApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getCaptableOptions();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_options()cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)
resp, _, err := client.CaptableAPI.GetCaptableOptions(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_options(&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).getCaptableOptions();curl https://api.hanzo.ai/v1/captable/options \
-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?