Plans & Playbooks

get_plan

Fetch a single plan by UUID with linked references, context collections, targeting dimensions, and metadata.

Parameters

Name	Type	Required	Default	Description
`plan_uuid`	`string`	Yes	—	The UUID of the plan to fetch (use plan_uuid, not the integer id).

Input Schema

{
  "type": "object",
  "required": [
    "plan_uuid"
  ],
  "properties": {
    "plan_uuid": {
      "type": "string",
      "description": "The UUID of the plan to fetch (use plan_uuid, not the integer id)."
    }
  }
}

Output Schema

{
  "type": "object",
  "required": [
    "plan"
  ],
  "properties": {
    "plan": {
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "description": "Internal PK; do not use externally."
        },
        "stage": {
          "enum": [
            "Suggested",
            "Accepted",
            "In_Process",
            "Complete",
            "Dismissed"
          ],
          "type": "string"
        },
        "title": {
          "type": "string"
        },
        "prompt": {
          "type": [
            "string",
            "null"
          ]
        },
        "source": {
          "enum": [
            "user_added",
            "cora_proactive",
            "cora_requested",
            "workflow",
            "playbook"
          ],
          "type": "string"
        },
        "team_id": {
          "type": "integer"
        },
        "due_date": {
          "type": [
            "string",
            "null"
          ]
        },
        "link_url": {
          "type": "string",
          "format": "uri",
          "description": "Shareable deep-link that opens the plans screen with this plan's detail overlay. Give this to the user."
        },
        "plan_uuid": {
          "type": "string"
        },
        "created_at": {
          "type": "integer"
        },
        "created_by": {
          "type": "integer"
        },
        "project_id": {
          "type": [
            "string",
            "null"
          ]
        },
        "updated_at": {
          "type": "integer"
        },
        "visibility": {
          "enum": [
            "private",
            "team"
          ],
          "type": "string",
          "description": "private = creator-only; team = visible to all active teammates."
        },
        "assigned_to": {
          "type": "integer"
        },
        "category_id": {
          "type": [
            "integer",
            "null"
          ]
        },
        "description": {
          "type": [
            "string",
            "null"
          ]
        },
        "blueprint_id": {
          "type": [
            "string",
            "null"
          ]
        },
        "completed_at": {
          "type": [
            "integer",
            "null"
          ]
        },
        "dismissed_at": {
          "type": [
            "integer",
            "null"
          ]
        },
        "source_metadata": {
          "type": [
            "object",
            "null"
          ]
        },
        "_produced_content": {
          "type": [
            "object",
            "null"
          ],
          "description": "The linked content object or null. When non-null contains at minimum: content_id, name, stage, visibility."
        },
        "context_collections": {
          "type": "array"
        },
        "produced_content_id": {
          "type": [
            "string",
            "null"
          ]
        },
        "reference_documents": {
          "type": "array",
          "description": "Content UUIDs accessible to the current user."
        },
        "targeting_dimensions": {
          "type": "array"
        },
        "_source_metadata_resolved": {
          "type": [
            "object",
            "null"
          ],
          "description": "Denormalized tooltip data (workflow_name resolved fresh; the cora_session_id / cora_message_snippet passthrough). Null if source=user_added."
        }
      }
    }
  }
}

Instructions

Fetches a single plan by its UUID, including all associated data.

Use plan_uuid (not the integer id) — always use the UUID form when working with plans.

The response includes:

All core plan fields (stage, title, source, dates, etc.)
reference_documents — content UUIDs accessible to the current user
context_collections — context collections pre-attached to the plan
targeting_dimensions — targeting dimension options pre-attached
_produced_content — the content item produced from this plan (or null if not yet created)
_source_metadata_resolved — resolved source metadata object (or null)

Links: present link_url to the user exactly as returned — copy it character for character. Never retype, shorten, or rebuild a link or the IDs inside it.