Read Workflow step run

GET

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

const url = 'https://api.aerandil.com/v1/object-types/hospitality.workflow_step_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_step_run/objects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Read an existing instance.

One step’s runtime state inside a workflow run. A retry increments attempt_count; a new step run row is created only for fan-out branches or subworkflow children. context_hash is the canonical JCS+SHA-256 over the proposal §4.4.2 input set; drift supersedes any held approval. The self-reference for compensation is on the workflow_step_run_compensates_step_run link, not an inline UUID.

Authorizations

aerandil_oauth
objects:read
aerandil_oauth
objects:hospitality.workflow_step_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_step_run

properties

required

object

action_name

Copied from definition for action steps

string

attempt_count

required

Starts at 0; increments before each attempt

integer

compensation_role

Marker for rows participating in a compensation relationship. Self-reference uses `workflow_step_run_compensates_step_run`, not an inline UUID.

string

Allowed values: original compensating_step

completed_at

Terminal step time

string format: date-time

context_hash

required

Canonical JCS+SHA-256 over the §4.4.2 input set

string

executed_by

`Principal::stable_id()` that executed or resolved the step

string

external_reference

PSP, PMS, Slack, Linear, webhook, or job reference

string

function_name

Copied from definition for function steps

string

required

Step run id

string

idempotency_key

Durable key used for mutating action/function/external call

string

last_error_code

Structured failure code

string

last_error_summary

Bounded failure summary

string

last_result_status

Raw result_status last recorded by the runner; failed_retryable normalizes to status waiting_for_retry.

string

Allowed values: succeeded failed_retryable failed_terminal skipped waiting_for_event waiting_for_retry canceled expired

max_attempts

required

From retry policy

integer

next_attempt_at

Set while waiting for retry

string format: date-time

parameter_snapshot

required

Frozen parameters after template resolution

result_snapshot

Frozen, redacted step result

started_at

First attempt start

string format: date-time

status

required

Lifecycle status

string

Allowed values: planned ready running waiting_for_approval waiting_for_event waiting_for_retry succeeded failed_terminal skipped cancel_requested canceled expired compensating compensated compensation_failed

step_key

required

Matches the definition step key

string

step_type

required

Copied from definition

string

Allowed values: action function approval_gate event_wait branch subworkflow external_task

target_ref

Workflow step run target ref

{object_type, object_id} resolved at runtime

object

object_id

required

string

object_type

required

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_step_run",
  "properties": {
    "compensation_role": "original",
    "last_result_status": "succeeded",
    "status": "planned",
    "step_type": "action"
  },
  "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).