Search Approval gate

POST

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

const url = 'https://api.aerandil.com/v1/object-types/hospitality.approval_gate/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.approval_gate/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.

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

aerandil_oauth
objects:read
aerandil_oauth
objects:hospitality.approval_gate: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 gate_key status approval_strategy required_approval_count requested_by context_hash decision_summary requested_at notified_at opened_at decided_at expires_at notification_target external_reference risk_tier

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.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

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

has_more

required

boolean

next_cursor

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

string

Example

{
  "data": [
    {
      "object_type": "hospitality.approval_gate",
      "properties": {
        "approval_strategy": "any_one",
        "notification_target": "in_product",
        "risk_tier": "read_only",
        "status": "requested"
      },
      "scope": {
        "level": "tenant"
      }
    }
  ]
}

422

Validation error — unknown property or filter type mismatch.

Search Approval gate

Authorizations

Request Bodyrequired

Responses

200

Example

422

Request Body^required