Skip to main content
GET
Read a chain's Business Model Canvas

Authorizations

Authorization
string
header
required

API key authentication. Pass your key as a Bearer token. Keys use the format hm_live_<32 hex chars>. Generate keys from your Harmonica dashboard settings.

Path Parameters

instanceId
string
required

Existing BMC chain instance ID; each chain has its own Canvas.

Minimum string length: 1

Query Parameters

stepIndex
integer

Zero-based review step for a participant read; must be at least 1 and no later than the current step. Ignored for an authorized management projection.

Required range: 0 <= x <= 9007199254740991
closing
boolean
default:false

Literal true selects the approved closing revision for a participant; takes precedence over stepIndex. Ignored for a management projection.

Response

Authorized management state or one participant-bound revision.

state
object | null
required

Null when current source changes withhold the saved Canvas; management and readiness remain available for recovery.

canEdit
boolean
required
canApproveClosing
boolean
required

True only when an editor may approve the current closing Canvas after a completed chain and current final extraction.

sourceStatus
enum<string>
required
Available options:
current,
changed
management
object
required
preparation
object[]
required

Per-round management status; empty for participant projections.

boundSnapshotHeld
boolean
required

A bound review snapshot has a changed source. Preparing a replacement does not replace that immutable binding; restart in a fresh chain to continue the affected round.

boundSnapshotMessage
string | null
required