Hanzo
OpenapiCompany

Counts the platform's formations by stage — the register's shape in one read,…

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…

GET /v1/company/register/summary

Addresshttps://api.hanzo.ai/v1/company/register/summary
MethodGET
Operationget_company_register_summary
AuthAuthorization: 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

StatusBodyMeaning
200registerCountsok

200 body — 3 fields.

FieldInTypeAlwaysDescription
byStagebodyobjectByStage counts formations per stage, keyed by the stage name.
byStage.*bodyinteger
totalbodyintegerTotal is every formation in the register.

Failure carries the platform error shape — see Errors.

Examples

hanzo company register summary

Company API · All Hanzo APIs · Interactive reference

How is this guide?

On this page