Search Workflow run

POST

/v1/object-types/hospitality.workflow_run/search

const url = 'https://api.aerandil.com/v1/object-types/hospitality.workflow_run/search';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"branch":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","cursor":"example","filters":[{"property":"id","type":"eq","value":"example"}],"limit":1,"order":"asc","property_id":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","scope":{"level":"tenant"},"sort_by":"created_at"}'
};

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

curl --request POST \
  --url https://api.aerandil.com/v1/object-types/hospitality.workflow_run/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "cursor": "example", "filters": [ { "property": "id", "type": "eq", "value": "example" } ], "limit": 1, "order": "asc", "property_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "scope": { "level": "tenant" }, "sort_by": "created_at" }'

Search for instances. Filters eq, contains, gte and lte AND-compose; or / not are additive follow-ups. Pages with an opaque cursor; the +1 fetch returns has_more without a second round-trip. Ordered by sort_by (default created_at) in order (default ascending), id breaking ties; rows with no value for a property key sort last.

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

Request Body^required

application/json

object

branch

Optional open-branch id. Search composes that branch’s copy-on-first-write overlay instead of main, so a preview reads its own hypothetical writes. Omit to read main.

string format: uuid

cursor

Opaque cursor from a prior response’s next_cursor. Pass back verbatim; do not introspect.

string

filters

Conjunctive list of predicates. Empty or omitted matches every row in scope, capped by limit.

Array

One of:

object

property

required

Allowed value: id

type

required

Allowed value: eq

value

required

string

limit

Page size. Server defaults to 50, silently clamps at 500 (AIP-158 §3).

integer

>= 1 <= 500

order

Direction of sort_by: asc (oldest / smallest first) or desc. A cursor is bound to the sort_by and order it was minted under; another pair is refused (422).

string

default: asc

Allowed values: asc desc

property_id

The house a desk stands in: keeps this property’s rows (property- or venue-scoped there) and every row scoped to no property (tenant, brand, portfolio), and drops a sibling house’s — the meaning property_id has on the event tail.

string format: uuid

scope

One of: discriminator: level

object

level

required

string

Allowed value: tenant

Allowed values: tenant

sort_by

What the page is ordered by: the row’s created_at or updated_at, or a property whose type orders — strings, enums and dates as text, ints, decimals and durations as numbers, datetimes as instants. Rows with no value sort last in either direction. A property the caller is not cleared to read is refused (403).

string

default: created_at

Allowed values: created_at updated_at id definition_id run_key workflow_key workflow_version definition_hash status trigger_kind request_fingerprint initiated_by delegated_agent_installation_id started_at last_transition_at completed_at expires_at correlation_id idempotency_key failure_summary compensation_summary contestability_ref

Responses

200

Search results, ordered by (sort_by, id) in the requested order (ascending by default).

application/json

object

data

required

Array<object>

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

has_more

required

boolean

next_cursor

Cursor for the next page; omitted when the result set is exhausted.

string

Example

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

422

Validation error — unknown property or filter type mismatch.

Search Workflow run

Authorizations

Request Bodyrequired

Responses

200

Example

422

Request Body^required