funnel:def-get

funnel family

Read one funnel definition by id — DRAFT OR PUBLISHED, the operator's read. Another tenant's id answers not_found, never their funnel

Effect: ask; Awaits an outcome — the call returns the response below.
Caller: manage_lifecycle; The class of authority the caller must already hold, decided from the attested context with no round trip.
Authority action: manage_lifecycle; Also gated per node — the caller must be permitted this action over the workspace it names.
Cost: free; What one call costs, so you can budget before acting.
Reversible: yes; The effect can be undone by a later call.
Idempotent: yes; Safe to retry as-is.
Version: 1.0.0; Pin this to keep a contract stable; additive bumps never break callers.

Send it with your agent

One click hands your coding agent a prompt that registers the substrate, reads this contract, and makes the call. Launch opens the app; the others copy the prompt.

Claude Code

Codex

Cursor

Gemini CLI

Claude Desktop

ChatGPT

curl -X POST https://one.ie/api/ask/funnel:def-get \
  -H "Authorization: Bearer $ONE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"data": { "funnelId": "6f1c9b2e-0000-4000-8000-000000000000" }}'

The key is never in a link. npx -y @oneie/cli login writes it to ~/.config/oneie/key on your machine.

Request

Validated before dispatch — an invalid payload is refused with the fix, never half-applied.

workspaceSlug string optional Workspace slug; defaults to the attested caller's. A slug you do not control is refused.
funnelId string required The funnel_definitions row id returned by funnel:create

Response

What comes back from the call.

ok boolean
def object
error string missing_fields | forbidden | not_found

Traffic

Every call to funnel:def-get, counted where it is dispatched — over HTTP or in-process alike. Aggregate only — no actor, no payload, no workspace.

Counting…

Wiring

Every place in the open source that names funnel:def-get, and the file that answers it. Read from the tree at build time — a receiver is reached by NAME through one door, so there is no import edge to follow and a grep is the honest shape of the question. Structure, not volume — the count is in Traffic above.

Called from

API route 3

one.ie/web/src/lib/funnel/types.ts:97
one.ie/web/src/lib/receiver-index.generated.ts:144
one.ie/web/src/pages/api/funnels/def.ts:14

→

Answered by

funnel:def-get one.ie/web/src/lib/resolvers/funnel.ts:17 Dispatched through POST /api/ask/funnel:def-get, after the envelope validates the payload.

funnel family · 4 more

funnel:advance funnel:create funnel:publish funnel:update-step

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "workspaceSlug": {
      "description": "Workspace slug; defaults to the attested caller's. A slug you do not control is refused.",
      "type": "string"
    },
    "funnelId": {
      "type": "string",
      "description": "The funnel_definitions row id returned by funnel:create"
    }
  },
  "required": [
    "funnelId"
  ]
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "ok": {
      "type": "boolean"
    },
    "def": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "slug": {
          "type": "string"
        },
        "workspaceSlug": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "status": {
          "type": "string",
          "description": "draft | published"
        },
        "playbookNode": {
          "type": "string"
        },
        "steps": {
          "type": "array",
          "items": {}
        },
        "edges": {
          "type": "array",
          "items": {}
        },
        "version": {
          "type": "number"
        },
        "createdAt": {
          "type": "number"
        },
        "updatedAt": {
          "type": "number"
        }
      },
      "required": [
        "id",
        "slug",
        "workspaceSlug",
        "name",
        "status",
        "steps",
        "edges",
        "version",
        "createdAt",
        "updatedAt"
      ]
    },
    "error": {
      "description": "missing_fields | forbidden | not_found",
      "type": "string"
    }
  },
  "required": [
    "ok"
  ]
}