Hanzo
OpenapiAuthor

Returns the caller's author-program dashboard: enrolment status, linked forge…

Returns the caller's author-program dashboard: enrolment status, linked forge login, verified repositories and owner-wide claims, recorded deploys,…

GET /v1/author

Addresshttps://api.hanzo.ai/v1/author
MethodGET
Operationget_author
AuthAuthorization: Bearer $HANZO_API_KEY

Returns the caller's author-program dashboard: enrolment status, linked forge login, verified repositories and owner-wide claims, recorded deploys, accrued / pending / paid royalty, and the payout history.

It answers ONE OF TWO SHAPES from this address. An org that has never connected gets {"isAuthor": false, "defaultShareBps", "badgeBase"} — an honest "not enrolled" rather than a 404, so the console can render the connect form. An enrolled org gets the dashboard: isAuthor, id, status, githubLogin, verified, verifyCode, verifyFile, verifySnippet, shareBps, badgeBase, repos, orgs, deploys, accruedCents, pendingCents, paidCents, payouts and ledger.

For an APPROVED author this read ALSO runs the accrual sweep opportunistically, so the dashboard is self-updating. That is why the royalty AUDIT lives at its own address: an audit must not move the money it is auditing.

Request

GET /v1/author takes no parameters and no body — the credential is the whole request.

Response

StatusBodyMeaning
200objectok

200 body — 1 field.

FieldInTypeAlwaysDescription
*bodyobject

Failure carries the platform error shape — see Errors.

Examples

hanzo authors get

Author API · All Hanzo APIs · Interactive reference

How is this guide?

On this page