> ## Documentation Index
> Fetch the complete documentation index at: https://docs.useorgx.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Read a stored initiative plan proposal

> Retrieve a proposal for review or diff. The returned
`proposal_digest` is exactly the value a commit must echo. Status is
one of proposed, instantiated (with `instantiated_initiative_id`), or
expired.



## OpenAPI

````yaml /openapi/v1.yaml get /initiatives/proposals/{proposalId}
openapi: 3.1.0
info:
  title: OrgX REST API v1
  version: '1'
  description: >-
    Build accountable work into your product with OrgX REST API v1.


    Create work with one field, attach evidence when it is complete, and keep
    the receipt. Every authenticated request is scoped to the workspace resolved
    from your credential.


    Start with `POST /work`. Human guide:
    https://docs.useorgx.com/docs/api/quickstart
  contact:
    name: OrgX Support
    url: https://useorgx.com/support
    email: support@useorgx.com
  license:
    name: Proprietary
    url: https://useorgx.com/terms
servers:
  - url: https://useorgx.com/api/v1
    description: Production
security: []
tags:
  - name: Work
    description: Create accountable work and complete it with evidence
  - name: Initiatives
    description: Organize related work around an outcome
  - name: Operating processes
    description: Evidence-backed company workflow/process lifecycle
  - name: Operating map
    description: Derived, rebuildable Operating Map projection over the process ledger
  - name: Discovery runs
    description: Wizard and deep-search workflow discovery over connected company sources
  - name: Handoffs
    description: Ledger-backed stage handoffs between operating-process stages
  - name: Events
    description: Replayable, workspace-scoped accepted ledger events
  - name: Projections
    description: Workspace-scoped, rebuildable read projections over OrgX sources
  - name: Episodes
    description: Mission-compatible Episode read adapters
  - name: Receipt validation
    description: Account-free Agent Work Receipt schema discovery and conformance
  - name: Receipt import
    description: Authenticated, workspace-scoped import into the hosted receipt ledger
  - name: Workload diagnosis
    description: >-
      Account-free evaluation of time, agents, systems, authority, and
      accountability boundaries
  - name: Content Studio
    description: >-
      Estimate, showcase, checkout, and payment event operations for Content
      Studio
  - name: Decisions
    description: Raise decisions for human ruling and read their state
  - name: Artifacts
    description: Register produced work against the entity it belongs to
  - name: Launches
    description: Preview and run an initiative launch through its spend gates
  - name: Runs
    description: Control agent runs with pause, resume, cancel, and rollback
  - name: Lifecycle
    description: Pause, resume, retry, or cancel work hierarchy nodes and runs
  - name: Deduplication
    description: Claim durable event fingerprints so duplicate triggers fire once
  - name: Credential
    description: >-
      Resolve the calling credential, the workspaces it reaches, and what it may
      do
  - name: API discovery
    description: Account-free error codes, request schemas, and closed vocabularies for v1
externalDocs:
  description: Human-readable OrgX REST API v1 reference
  url: https://docs.useorgx.com/docs/api/public-api
paths:
  /initiatives/proposals/{proposalId}:
    get:
      tags:
        - Initiatives
      summary: Read a stored initiative plan proposal
      description: |-
        Retrieve a proposal for review or diff. The returned
        `proposal_digest` is exactly the value a commit must echo. Status is
        one of proposed, instantiated (with `instantiated_initiative_id`), or
        expired.
      operationId: getInitiativeScaffoldProposal
      parameters:
        - name: proposalId
          in: path
          required: true
          description: Proposal UUID
          schema:
            type: string
            format: uuid
        - name: workspace_id
          in: query
          required: false
          description: Workspace scope; optional when the API key is workspace-bound
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: The stored proposal
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InitiativeProposalDetailResponse'
              example:
                data:
                  proposal_id: 7c1f9a34-5b2e-4d8f-9a01-3e6b7c8d9e0f
                  proposal_digest: >-
                    sha256:9b2f1c0d8a7e6b5c4d3e2f1a0b9c8d7e6f5a4b3c2d1e0f9a8b7c6d5e4f3a2b1c
                  status: proposed
                  expires_at: '2026-08-26T12:00:00.000Z'
                  plan:
                    initiative:
                      title: Launch the customer API
                    workstreams:
                      - name: Strategy
                        domain: product
                        agent_id: product-agent
                  assignment_source: baseline
                  economics:
                    expected_tokens: 8000
                    expected_hours: 5
                    expected_budget_usd: 0.4
                    human_equivalent_usd: 599.6
                    value_basis: market_rate_by_task_type_less_spend
                  context:
                    depth: full
                    agent_assignment: auto
                  source_evidence: null
                  created_at: '2026-08-19T12:00:00.000Z'
                meta:
                  apiVersion: '1'
                  workspaceId: 09707fa5-aaae-4493-8a23-827111000f89
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
      security:
        - bearerAuth: []
        - cookieAuth: []
components:
  schemas:
    InitiativeProposalDetailResponse:
      type: object
      required:
        - data
        - meta
      properties:
        data:
          type: object
          required:
            - proposal_id
            - proposal_digest
            - status
            - expires_at
            - plan
            - assignment_source
            - economics
          properties:
            proposal_id:
              type: string
              format: uuid
            proposal_digest:
              type: string
              pattern: ^sha256:[0-9a-f]{64}$
            status:
              type: string
              enum:
                - proposed
                - instantiated
                - expired
            expires_at:
              type: string
              format: date-time
            plan:
              $ref: '#/components/schemas/InitiativePlan'
            assignment_source:
              type: string
              enum:
                - model
                - baseline
            economics:
              type: object
            context:
              type: object
            source_evidence:
              type:
                - object
                - 'null'
            instantiated_initiative_id:
              type: string
              format: uuid
            created_at:
              type: string
              format: date-time
        meta:
          type: object
          required:
            - apiVersion
            - workspaceId
          properties:
            apiVersion:
              type: string
              const: '1'
            workspaceId:
              type: string
              format: uuid
    InitiativePlan:
      type: object
      additionalProperties: false
      required:
        - initiative
        - workstreams
      properties:
        initiative:
          type: object
          additionalProperties: false
          required:
            - title
          properties:
            title:
              type: string
              minLength: 1
              maxLength: 240
            summary:
              type:
                - string
                - 'null'
              maxLength: 4000
        workstreams:
          type: array
          minItems: 1
          maxItems: 20
          items:
            $ref: '#/components/schemas/InitiativePlanWorkstream'
    ApiError:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
            details:
              type: object
            requestId:
              type: string
            timestamp:
              type: string
              format: date-time
            docsUrl:
              type: string
              format: uri
            retryAfter:
              type: integer
              description: Seconds until rate limit resets
    InitiativePlanWorkstream:
      type: object
      additionalProperties: false
      required:
        - name
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 240
        goal:
          type:
            - string
            - 'null'
          maxLength: 4000
        domain:
          type: string
          enum:
            - product
            - engineering
            - marketing
            - sales
            - operations
            - design
            - orchestration
        agent_id:
          type: string
        agent_name:
          type: string
        confidence:
          type: number
          minimum: 0
          maximum: 1
        rationale:
          type: string
          maxLength: 2000
        depends_on:
          type: array
          maxItems: 20
          items:
            type: string
          description: Names of sibling workstreams
        deliverables:
          type: array
          maxItems: 20
          items:
            type: string
        expected_tokens:
          type: integer
          minimum: 1
        expected_duration_hours:
          type: number
          exclusiveMinimum: 0
        expected_budget_usd:
          type: number
          exclusiveMinimum: 0
        milestones:
          type: array
          maxItems: 10
          items:
            $ref: '#/components/schemas/InitiativePlanMilestone'
    InitiativePlanMilestone:
      type: object
      additionalProperties: false
      required:
        - title
      properties:
        title:
          type: string
          minLength: 1
          maxLength: 240
        description:
          type:
            - string
            - 'null'
          maxLength: 4000
        tasks:
          type: array
          maxItems: 15
          items:
            $ref: '#/components/schemas/InitiativePlanTask'
    InitiativePlanTask:
      type: object
      additionalProperties: false
      required:
        - title
      properties:
        title:
          type: string
          minLength: 1
          maxLength: 240
        detail:
          type:
            - string
            - 'null'
          maxLength: 4000
        type:
          type: string
          enum:
            - research
            - create
            - review
            - implement
        depends_on:
          type: array
          maxItems: 15
          items:
            type: string
          description: Titles of sibling tasks in the same milestone
        agent_id:
          type: string
          description: Canonical '-agent' id
        expected_tokens:
          type: integer
          minimum: 1
        expected_duration_hours:
          type: number
          exclusiveMinimum: 0
        expected_budget_usd:
          type: number
          exclusiveMinimum: 0
  responses:
    BadRequest:
      description: Request validation failed
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    Unauthorized:
      description: Authentication required
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    NotFound:
      description: Resource is unavailable to the caller
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    ServiceUnavailable:
      description: Ledger or workspace authorization is unavailable
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'OrgX API key, sent as `Authorization: Bearer oxk_...`'
    cookieAuth:
      type: apiKey
      in: cookie
      name: __session
      description: Session cookie from web authentication

````