API ReferenceNavigate to Care

Get a pathway execution envelope

View as MarkdownOpen in Claude
Returns the lifecycle envelope for a pathway execution. The envelope carries identity, pinned pathway version, channel, status, start and end timestamps, and the outcome code when completed. Use this endpoint to recover state after a client restart or to verify that a completion has been recorded. Node state is fetched separately via the current-node endpoint. Returns a 404 when the execution does not exist or is not scoped to the caller.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idstringRequired
Stable identifier of the pathway execution.

Response

The execution envelope.
idstring
Stable identifier for the pathway execution.
planDefinitionIdstring
Stable identifier of the pathway definition this execution is pinned to.
planDefinitionVersionIddouble

Pathway version pinned at start. All subsequent endpoint validation runs against this version. A mid-execution republish is invisible to in-flight executions.

channelenum

Channel the execution is being driven through. Recorded for analytics; engine behaviour is identical across channels.

statusenum

Lifecycle state. One-shot transitions: in-progress to completed, or in-progress to abandoned.

startedAtstring
ISO 8601 timestamp at which the execution started.
endedAtstring

ISO 8601 timestamp at which the execution ended. Present when status is not in-progress.

outcomeCodestring

Outcome code for a completed execution. Mirrors the value recorded on the encounter row. Absent on in-progress and abandoned executions.