Skip to content
aerandil.com
GitHub

Read Approval gate

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

Read an existing instance.

Durable approval gate. Carries an approval_strategy, eligible principals / role refs, a context_snapshot of the facts shown to approvers, and a context_hash over the §4.4.2 input set. Material drift on the underlying parameters, prior outputs, or policy invalidates the gate via workflow_step_context_hash_stable. Gates can be used standalone for single-action approvals or attached to a workflow step via approval_gate_for_workflow_step_run.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string format: uuid

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

Query Parameters

Section titled “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

Section titled “Responses”

200

Section titled “200”

Object found.

Media typeapplication/json
object
created_at
required
string format: date-time
id
required
string format: uuid
object_type
required
Allowed value: hospitality.approval_gate
properties
required
object
approval_strategy
required
How the gate combines decisions to reach `approved`
string
Allowed values: any_one all quorum role_based ordered_chain separation_of_duties
assigned_to
Current assignees, if narrowed
Array<string>
context_hash
required
Canonical JCS+SHA-256 over the §4.4.2 input set
string
context_snapshot
required
Frozen, redacted facts shown to approvers
decided_at
Final decision time
string format: date-time
decision_summary
Final bounded summary
string
eligible_principal_ids
Exact eligible principals when known (Principal::stable_id() shape)
Array<string>
eligible_role_refs
Staff roles / groups that may approve
Array<string>
excluded_principal_ids
Requesting agent / author / conflicted principals
Array<string>
expires_at
Gate timeout
string format: date-time
external_reference
Slack ts, Linear issue id, PMS task id, email thread id, etc.
string
gate_key
required
Stable within the workflow run or action correlation id
string
id
required
Gate id
string
notification_target
Where the gate notification surfaced
string
Allowed values: in_product slack linear email pms_task webhook other
notified_at
First notification sent
string format: date-time
opened_at
First in-product open/view event when known
string format: date-time
requested_at
required
Gate creation
string format: date-time
requested_by
Principal stable id of the gate requester
string
required_approval_count
Required for `approval_strategy = quorum`
integer
risk_tier
required
Copied from guarded step / action; drives high-risk policy validators
string
Allowed values: read_only internal_write guest_message money_movement identity_or_fraud clinical_or_regulated other_high_risk
stale_on_context_change
required
Whether material drift invalidates the gate (default true, GitHub-style)
boolean
status
required
Lifecycle status
string
Allowed values: requested assigned notified opened partially_approved approved rejected changes_requested delegated expired canceled superseded
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.approval_gate",
  "properties": {
    "approval_strategy": "any_one",
    "notification_target": "in_product",
    "risk_tier": "read_only",
    "status": "requested"
  },
  "scope": {
    "level": "tenant"
  }
}

Headers

Section titled “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

Section titled “404”

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