ONE campaign:get
← Receivers

campaign:get

campaign family

mcp

Every campaign in your workspace (or one) scored against the marketing SOPs it runs: per SOP the verdict word (kill, scale, hold, warn, ok, unknown) the sop-<slug> paths branch on, the step it is on, the gates and each rule's state with why. A number ONE cannot read is unknown, never 0

Effect
ask
Awaits an outcome — the call returns the response below.
Caller
manage_workspace
The class of authority the caller must already hold, decided from the attested context with no round trip.
Authority action
read_revenue
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/campaign:get \
  -H "Authorization: Bearer $ONE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"data": { "campaignId": "01a1edad703405d807b6b913" }}'

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.

  • view score optional What to read about the campaigns. `score` (the default, and the only view today): the SOP verdicts
  • campaignId string optional One campaign's gid; omit for every campaign in the caller's workspace, running ones first. The workspace is always the attested caller's — no body field names it

Response

What comes back from the call.

  • ok boolean
  • workspace string Always the attested caller's workspace
  • windowDays number The days of events and spend the scores read
  • total number Campaigns that matched, before the cap
  • limit number The most campaigns one answer carries
  • capped boolean true when total > limit: the answer is SHORT, ask by campaignId for the rest
  • campaigns object[]
  • error string forbidden | bad_campaign_id | no_db | read_failed | not_found

Traffic

Every call to campaign: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 campaign: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 1
  • one.ie/web/src/lib/receiver-index.generated.ts:85
SDK 1
  • packages/sdk/src/receiver-layers.ts:847
→

Answered by

campaign:get one.ie/web/src/lib/resolvers/campaigns.ts:519 Dispatched through POST /api/ask/campaign:get, after the envelope validates the payload.
JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "view": {
      "description": "What to read about the campaigns. `score` (the default, and the only view today): the SOP verdicts",
      "type": "string",
      "enum": [
        "score"
      ]
    },
    "campaignId": {
      "description": "One campaign's gid; omit for every campaign in the caller's workspace, running ones first. The workspace is always the attested caller's — no body field names it",
      "type": "string"
    }
  }
}
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "ok": {
      "type": "boolean"
    },
    "workspace": {
      "description": "Always the attested caller's workspace",
      "type": "string"
    },
    "windowDays": {
      "description": "The days of events and spend the scores read",
      "type": "number"
    },
    "total": {
      "description": "Campaigns that matched, before the cap",
      "type": "number"
    },
    "limit": {
      "description": "The most campaigns one answer carries",
      "type": "number"
    },
    "capped": {
      "description": "true when total > limit: the answer is SHORT, ask by campaignId for the rest",
      "type": "boolean"
    },
    "campaigns": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "gid": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "vertical": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "live": {
            "type": "boolean"
          },
          "sops": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "slug": {
                  "type": "string"
                },
                "title": {
                  "type": "string"
                },
                "verdict": {
                  "type": "string",
                  "description": "kill outranks all; anything unread makes it unknown, never ok"
                },
                "step": {
                  "anyOf": [
                    {
                      "type": "object",
                      "properties": {
                        "n": {
                          "type": "number"
                        },
                        "title": {
                          "type": "string"
                        },
                        "who": {
                          "type": "string"
                        },
                        "doneWhen": {
                          "type": "string"
                        }
                      },
                      "required": [
                        "n",
                        "title",
                        "who",
                        "doneWhen"
                      ]
                    },
                    {
                      "type": "null"
                    }
                  ],
                  "description": "null = no tag says which step"
                },
                "gates": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "string"
                      },
                      "must": {
                        "type": "string"
                      },
                      "state": {
                        "type": "string"
                      }
                    },
                    "required": [
                      "id",
                      "must",
                      "state"
                    ]
                  }
                },
                "kpis": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "key": {
                        "type": "string"
                      },
                      "name": {
                        "type": "string"
                      },
                      "state": {
                        "type": "string"
                      },
                      "shown": {
                        "type": "string"
                      },
                      "why": {
                        "type": "string"
                      }
                    },
                    "required": [
                      "key",
                      "name",
                      "state",
                      "shown",
                      "why"
                    ]
                  }
                },
                "href": {
                  "type": "string",
                  "description": "The member SOP page"
                }
              },
              "required": [
                "slug",
                "title",
                "verdict",
                "step",
                "gates",
                "kpis",
                "href"
              ]
            }
          }
        },
        "required": [
          "gid",
          "name",
          "vertical",
          "live",
          "sops"
        ]
      }
    },
    "error": {
      "description": "forbidden | bad_campaign_id | no_db | read_failed | not_found",
      "type": "string"
    }
  },
  "required": [
    "ok"
  ]
}