Read Workflow run

GET

/v1/object-types/hospitality.workflow_run/objects/{id}

const url = 'https://api.aerandil.com/v1/object-types/hospitality.workflow_run/objects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.aerandil.com/v1/object-types/hospitality.workflow_run/objects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Read an existing instance.

One durable execution pinned to exactly one active definition version. definition_hash is copied at start so the run can prove the exact shape it executed even if the definition is later deprecated. target_refs_snapshot is a redacted convenience snapshot — graph traversal uses concrete workflow_run_targets_* links. The runner that advances steps is a separate proposal (§9.2).

Authorizations

aerandil_oauth
objects:read
aerandil_oauth
objects:hospitality.workflow_run:read

Parameters

Path Parameters

required

string format: uuid

Object id (UUID v7, server-generated at create time).

Query Parameters

branch

string format: uuid

Read through an open branch’s copy-on-first-write overlay view instead of the canonical (main) plane. Does not compose with as_of (422). The branch must exist under the caller’s tenant.

Responses

200

Object found.

application/json

object

created_at

required

string format: date-time

required

string format: uuid

object_type

required

Allowed value: hospitality.workflow_run

properties

required

object

compensation_summary

Bounded compensation outcome

string

completed_at

Terminal success / failure / cancellation / compensation terminal

string format: date-time

contestability_ref

External support / appeal reference for guest-impacting automated decisions

string

correlation_id

required

Root correlation id for event joins

string

current_step_keys

required

Active / waiting step keys for fast display

Array<string>

definition_hash

required

Copied from definition at start time. Drift rejects step execution.

string

definition_id

required

Workflow definition object id. Part of the durable idempotency key.

string

delegated_agent_installation_id

Set when an installed agent initiated the run; mirrors the `workflow_run_started_by_agent_installation` link target

string

expires_at

Run timeout

string format: date-time

failure_summary

Bounded terminal failure summary; full details stay on step runs

string

required

Run id

string

idempotency_key

required

Key used to start the run

string

initiated_by

`Principal::stable_id()` of caller that started the run

string

input_snapshot

required

Frozen, redacted start input

last_transition_at

required

Updated on every lifecycle transition

string format: date-time

output_snapshot

Frozen completion output

request_fingerprint

required

SHA-256 over canonical start request fields. Same run_key with a different fingerprint is rejected.

string

run_key

required

Host-supplied business / dedupe key. Immutable.

string

started_at

required

Wall-clock start

string format: date-time

status

required

Lifecycle status

string

Allowed values: pending running waiting_for_approval waiting_for_event waiting_for_retry completed failed_pending_compensation failed_terminal cancel_requested canceled expired compensating compensated compensation_failed

target_refs_snapshot

Workflow run target refs snapshot

Frozen {object_type, object_id} targets requested at start. Convenience snapshot only — graph traversal uses concrete workflow_run_targets_* links and never embeds payloads.

Array<object>

object

object_id

required

string

object_type

required

string

trigger_kind

required

Copied from start request or definition default

string

Allowed values: manual event schedule webhook agent_requested api

workflow_key

required

Copied from definition at start time

string

workflow_version

required

Copied from definition at start time

string

provenance

Per-property source attribution and pins. An entry under properties means the property’s current value came from that source (on the source’s own clock, source_updated_at); an entry under pins is a human override protecting the property from sourced writes.

object

pins

object

key

additional properties

object

pinned_at

string format: date-time

pinned_by

object

reason

required

string

properties

object

key

additional properties

object

external_id

string

recorded_at

required

string format: date-time

source

required

string

source_updated_at

string format: date-time

stream

string

scope

required

One of: discriminator: level

object

level

required

string

Allowed value: tenant

Allowed values: tenant

tenant_id

required

string format: uuid

updated_at

required

string format: date-time

version

required

integer

>= 1

Example

{
  "object_type": "hospitality.workflow_run",
  "properties": {
    "status": "pending",
    "trigger_kind": "manual"
  },
  "scope": {
    "level": "tenant"
  }
}

Headers

ETag

string

/^"\d+"$/

Quoted strong validator (RFC 7232 §2.3) carrying the object’s monotonic version. Informational on the read path — object mutation goes through typed actions on /v1/actions/{action}/apply, not raw CRUD.

404

No object with that id (or soft-deleted).