Form

The hanzo form commands.

Also for this capability: API · CLI · MCP · SDKs

Mounts forms (github.com/hanzoai/form) at /v1/form, the way apps/iam mounts hanzoai/iam: the module owns every route and every rule of a form, and this package hands it what only cloud knows.

API reference →

hanzo form forms list

Every command takes --json for the raw response and --help for its own flags. Sign in once with hanzo auth login; the commands below use that session, and the org they act in is the one it carries.

Forms

Command	What it does
`hanzo form forms create`	Makes a form in the caller's org and answers it as stored, its fields' ids assigned and its defaults filled: kind form, visibility public, language en, one question at a time, and the platform's default sinks when it names none.
`hanzo form forms export <id>`	Exports a form's responses as JSON or CSV, a page of up to 5000 at a time under the same filter a listing takes; next is the page to ask for after it, 0 at the end.
`hanzo form forms get <id>`	Reads one form of the caller's org, by its id or its slug.
`hanzo form forms import <id>`	Brings responses made elsewhere into a form, keeping when each was made, a batch of at most 500 at a time.
`hanzo form forms list`	Lists the caller org's forms, newest first, a page at a time; search keeps the forms whose title holds it and tag the ones carrying it.
`hanzo form forms responses file <id> <response>`	Files a completed response on the CRM's timeline now, and answers the response with whether it is filed and, when it is not, why.
`hanzo form forms responses get <id> <response>`	Reads one response of a form.
`hanzo form forms responses list <id>`	Lists a form's responses, newest first, a page at a time: since and until bound when they were made, completed keeps the finished or the open ones, query keeps the ones whose answers hold it, and included_response_ids and excluded_response_ids keep or drop named ones.
`hanzo form forms responses rm <id> <response>`	Deletes one response of a form, and its webhook deliveries.
`hanzo form forms rm <id>`	Deletes a form with every response, webhook and delivery it has, and the webhooks' signing secrets.
`hanzo form forms set <id>`	Replaces a form whole and answers it as stored.
`hanzo form forms summary <id>`	Sums up a form's responses: how many were begun and completed, and for each field how many answered it, the distribution of what was said (choices, points, yes and no), the mean, least and most of a number, and how many open responses stopped in front of it.
`hanzo form forms update <id>`	Changes the parts of a form the body names and keeps the rest, then answers it as stored.
`hanzo form forms webhooks create <id>`	Adds a webhook to a form: every completed response is posted to its https address as JSON, signed with Hanzo-Signature: t=<unix seconds>,sha256=<base64 of HMAC-SHA256(secret, "<seconds>." + body)>; a receiver refuses a timestamp older than five minutes and an event_id it has seen.
`hanzo form forms webhooks deliveries list <id> <webhook>`	Lists a webhook's deliveries, newest first: each response posted, how many attempts it took, the last status the address answered and why it failed.
`hanzo form forms webhooks deliveries retry <id> <webhook> <delivery>`	Posts a delivery's response to its webhook again, now, and answers how it went.
`hanzo form forms webhooks get <id> <webhook>`	Reads one webhook of a form.
`hanzo form forms webhooks list <id>`	Lists a form's webhooks.
`hanzo form forms webhooks rm <id> <webhook>`	Deletes a webhook, its deliveries and its secret.
`hanzo form forms webhooks set <id> <webhook>`	Replaces a webhook's tag, address and whether it is enabled.

Public

Command	What it does
`hanzo form public get <id>`	Reads a published form as its page draws it: the questions, the screens, the hidden values it takes, how it is answered and its theme.
`hanzo form public responses <id>`	Answers a published form.

Themes

Command	What it does
`hanzo form themes create`	Makes a theme in the caller's org: a name, four colours (#rrggbb), a font family and an https background image, each optional but the name.
`hanzo form themes get <id>`	Reads one theme of the caller's org.
`hanzo form themes list`	Lists the caller org's themes by name.
`hanzo form themes rm <id>`	Deletes a theme.
`hanzo form themes set <id>`	Replaces a theme whole; every form drawn in it is drawn in the new one.

Was this page useful?

Broken link or missing step? Drop it in #docs on Discord or open a PR.

PreviousContent NextLibrary