asksteps: read one funnel with its branching
asksteps_get_funnelRead-onlyIdempotent
Reads one funnel of the connected asksteps account: its questions, answers and where each answer leads. Requires "forms:read". ALWAYS call this before asksteps_update_funnel — the write replaces every question, so you need the current state to keep what you are not changing. If the id turns out to be a flat form, the answer says so and points you at asksteps_get_form.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| funnel_id | Yes | The funnel id, as returned by asksteps_list_forms. |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | The name of the funnel as the customer sees it in their account. | |
| note | Yes | One sentence for the user, explaining the outcome and what to do next. | |
| spec | No | The structure of the funnel, in the same shape asksteps_update_funnel expects. | |
| status | Yes | Outcome. One of: "ok", "not_connected", "not_found", "not_a_funnel" (this is a flat form — use asksteps_get_form instead), "error". Authorisation can also refuse before the tool runs: "plan_required" (the account's plan does not include agent access), "not_enabled" (the account owner has not switched agent access on), "owner_required" (only the account owner may do this), "mandate_required" (the owner has not granted a mandate for this). The note then says what the user has to do. | |
| editable | No | Whether asksteps_update_funnel may write this funnel back. When false, DO NOT try — it contains things this format cannot describe, and writing would delete them. | |
| funnelId | No | The id of the funnel, to pass back to asksteps_update_funnel. | |
| blockedBy | No | Why writing is blocked, in one sentence. Empty when editable. | |
| themeCustomized | No | True when the funnel uses a hand-built design instead of one of the presets. | |
| screensBlockedBy | No | Why the intro/success/dismiss pages must not be sent back. Empty when they may be. |