# List summary

URL: https://docs.hanzo.ai/docs/openapi/company/get-company-register-summary

> Counts the platform's formations by stage — the register's shape in one read, so a queue that is growing is visible as a number rather than inferred by paging the list.

`GET /v1/company/register/summary`

> [Company →](https://docs.hanzo.ai/docs/openapi/company) · [All API references →](https://docs.hanzo.ai/docs/openapi) · [Get started →](https://docs.hanzo.ai/docs/guides)

|               |                                                    |
| ------------- | -------------------------------------------------- |
| **Address**   | `https://api.hanzo.ai/v1/company/register/summary` |
| **Method**    | `GET`                                              |
| **Operation** | `get_company_register_summary`                     |
| **Auth**      | `Authorization: Bearer $HANZO_API_KEY`             |

Counts the platform's formations by stage — the register's
shape in one read, so a queue that is growing is visible as a number rather
than inferred by paging the list. A Hanzo platform operation: a caller who is
not a platform reviewer gets 403.

## Request

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

## Response

| Status    | Body                   | Meaning |
| --------- | ---------------------- | ------- |
| `200`     | company.registerCounts | ok      |
| `default` | problem-details        | refused |

`200` body — 3 fields.

| Field       | In   | Type            | Always | Description                                                   |
| ----------- | ---- | --------------- | ------ | ------------------------------------------------------------- |
| `byStage`   | body | object          | —      | ByStage counts formations per stage, keyed by the stage name. |
| `byStage.*` | body | integer (int64) | —      |                                                               |
| `total`     | body | integer (int64) | —      | Total is every formation in the register.                     |

Failure carries the platform error shape — see [Errors](https://docs.hanzo.ai/docs/errors).

## Examples

**CLI**

```bash
hanzo company register summary
```

**SDK**

**.ts**

```ts
import { Configuration, CompanyApi } from 'hanzoai';

const api = new CompanyApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getCompanyRegisterSummary();
```

**.py**

```python
from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import CompanyApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = CompanyApi(client).get_company_register_summary()
```

**.go**

```go
cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.CompanyAPI.GetCompanyRegisterSummary(context.Background()).Execute()
if err != nil {
	return err
}
```

**.rs**

```rust
use hanzo_client::apis::{configuration::Configuration, company_api};

let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();

let result = company_api::get_company_register_summary(&cfg, Default::default()).await?;
```

**.java**

```java
import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.CompanyApi;

ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));

var result = new CompanyApi(client).getCompanyRegisterSummary();
```

**HTTP**

```bash
curl https://api.hanzo.ai/v1/company/register/summary \
  -H "Authorization: Bearer $HANZO_API_KEY"
```

**MCP**

Tool `company`, op `get_company_register_summary` — POST the JSON-RPC envelope to `https://api.hanzo.ai/v1/mcp`.

```bash
curl -X POST https://api.hanzo.ai/v1/mcp \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "jsonrpc": "2.0",
       "id": 1,
       "method": "tools/call",
       "params": {
         "name": "company",
         "arguments": {
           "op": "get_company_register_summary",
           "input": {}
         }
       }
     }'
```

---

[Company API](https://docs.hanzo.ai/docs/openapi/company) · [All Hanzo APIs](https://docs.hanzo.ai/docs/openapi) · [Interactive reference](https://docs.hanzo.ai/docs/openapi/reference)