OpenapiCaptable
Returns the caller org's share certificates, newest first.
Returns the caller org's share certificates, newest first.
GET /v1/captable/shares
| Address | https://api.hanzo.ai/v1/captable/shares |
| Method | GET |
| Operation | get_captable_shares |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Returns the caller org's share certificates, newest first. Each row is joined to its holder and its share class, so a certificate names who holds it and what class it is in without a second call.
Request
GET /v1/captable/shares takes no parameters and no body — the credential is the whole request.
Response
| Status | Body | Meaning |
|---|---|---|
200 | captableShares | ok |
200 body — 14 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
data | body | captableShare[] | — | Data is every issued share certificate, newest first. |
data[].capitalContribution | body | number | — | CapitalContribution is the cash paid for the certificate, if recorded. |
data[].certificateId | body | string | — | CertificateID is the certificate number, unique within the company. |
data[].companyLegends | body | string[] | — | CompanyLegends are the restrictive legends printed on the certificate. |
data[].id | body | string | — | ID is the share id. |
data[].issueDate | body | string | — | IssueDate is the ISO date the certificate was issued. |
data[].pricePerShare | body | number | — | PricePerShare is the price paid per share, if recorded. |
data[].quantity | body | integer | — | Quantity is how many shares the certificate covers. |
data[].shareClassId | body | string | — | ShareClassID is the class the shares belong to. |
data[].shareClassName | body | string | — | ShareClassName is that class's name. |
data[].shareClassType | body | string | — | ShareClassType is that class's type, COMMON or PREFERRED. |
data[].stakeholderId | body | string | — | StakeholderID is the holder of the certificate. |
data[].stakeholderName | body | string | — | StakeholderName is that holder's name. |
data[].status | body | string | — | Status is ACTIVE or DRAFT. |
Failure carries the platform error shape — see Errors.
Examples
hanzo captable shares listimport { Configuration, CaptableApi } from 'hanzoai';
const api = new CaptableApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getCaptableShares();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_shares()cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)
resp, _, err := client.CaptableAPI.GetCaptableShares(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_shares(&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).getCaptableShares();curl https://api.hanzo.ai/v1/captable/shares \
-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?