Skip to content
aerandil.com
GitHub

Traverse from Property

POST
/v1/object-types/hospitality.property/objects/{id}/traverse
curl --request POST \
  --url https://api.aerandil.com/v1/object-types/hospitality.property/objects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/traverse \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "as_of": "2026-04-15T12:00:00Z", "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "cursor": "example", "direction": "out", "limit": 1, "link_type": "hospitality.link.block_for_property", "role": "example" }'

RPC-shaped traversal. Pick the edge by (link_type, direction) or by role — the registry resolves a role name (e.g. managed_by, direct_reports) to the underlying link side. link_type wins when both are present.

A single operated site — a hotel or resort, or a non-lodging business run on the same substrate (a standalone day spa). The property is the canonical home of most operational data and the anchor for local timezone, currency, and brand standards.

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

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json

Body for POST .../traverse. At least one of link_type or role MUST be supplied — the server returns 422 missing_traversal_target when both are absent. link_type wins when both are set.

object
as_of

RFC3339 temporal window: return neighbours whose edge was in effect at this instant ([effective_from, effective_to)) instead of now.

string format: date-time
branch

Traverse through an open branch’s overlay view instead of the canonical (main) plane. Does not compose with as_of (422).

string format: uuid
cursor
string
direction

Edge direction. Optional when the binding is asymmetric.

Allowed values: out in
limit
integer
>= 1 <= 500
link_type

API name of the link type to traverse. Narrowed to link types that bind the source. Wins over role.

Allowed values: hospitality.link.block_for_property hospitality.link.board_sort_pattern_at_property hospitality.link.brand_has_property hospitality.link.brand_operator_cost_at_property hospitality.link.cancellation_policy_at_property hospitality.link.cashier_at_property hospitality.link.channel_commission_period_for_property hospitality.link.channel_connection_for_property hospitality.link.channel_for_property hospitality.link.checklist_template_at_property hospitality.link.commission_agreement_for_property hospitality.link.commission_batch_for_property hospitality.link.comp_authority_policy_at_property hospitality.link.demand_forecast_for_property hospitality.link.deposit_policy_at_property hospitality.link.desk_session_at_property hospitality.link.development_pathway_definition_at_property hospitality.link.device_at_property hospitality.link.fault_type_at_property hospitality.link.federated_participation_for_property hospitality.link.feedback_label_at_property hospitality.link.folio_routing_rule_at_property hospitality.link.fraud_assessment_at_property hospitality.link.fraud_network_contribution_at_property hospitality.link.fraud_network_signal_at_property hospitality.link.function_event_at_property hospitality.link.function_space_at_property hospitality.link.group_request_for_property hospitality.link.guest_conversation_at_property hospitality.link.housekeeping_briefing_at_property hospitality.link.housekeeping_credit_rule_at_property hospitality.link.incidental_hold_policy_at_property hospitality.link.ingredient_at_property hospitality.link.ingredient_supplier_price_at_property hospitality.link.labour_entry_at_property hospitality.link.loyalty_program_at_property hospitality.link.management_agreement_covers_property hospitality.link.material_at_property hospitality.link.membership_at_property hospitality.link.membership_grants_access_at_property hospitality.link.merchant_account_for_property hospitality.link.message_triage_at_property hospitality.link.no_show_posting_rule_at_property hospitality.link.outlet_at_property hospitality.link.owner_statement_for_property hospitality.link.package_at_property hospitality.link.pattern_at_property hospitality.link.portfolio_has_property hospitality.link.property_budget_for_property hospitality.link.property_has_availability_day hospitality.link.property_has_business_date hospitality.link.property_has_channel_mix_snapshot hospitality.link.property_has_design_dna hospitality.link.property_has_night_audit_run hospitality.link.property_has_philosophy hospitality.link.property_has_rate_plan hospitality.link.property_has_room hospitality.link.property_has_room_type hospitality.link.property_has_venue hospitality.link.property_owned_by_company hospitality.link.recipe_at_property hospitality.link.recognition_event_at_property hospitality.link.recommendation_at_property hospitality.link.recovery_pattern_run_for_property hospitality.link.reservation_for_property hospitality.link.restriction_recommendation_at_property hospitality.link.retail_product_available_at_property hospitality.link.round_template_at_property hospitality.link.run_for_property hospitality.link.sell_limit_recommendation_at_property hospitality.link.share_group_at_property hospitality.link.shift_at_property hospitality.link.staff_works_at_property hospitality.link.stay_offer_for_property hospitality.link.stock_store_at_property hospitality.link.stored_object_for_property hospitality.link.tax_rule_at_property hospitality.link.turnaway_for_property hospitality.link.utility_entry_at_property hospitality.link.venue_brand_originated_at_property hospitality.link.waitlist_entry_for_property
role

Link-side role name (e.g. managed_by, direct_reports). Mutually substitutable with link_type — the registry resolves the role to its underlying link and direction.

string

Responses

Section titled “Responses”

200

Section titled “200”

Neighbours along the resolved link.

Media typeapplication/json
object
data
required
Array<object>
object
created_at
required
string format: date-time
id
required
string format: uuid
object_type
required
string
properties
required
object
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
direction
required
Allowed values: out in
has_more
required
boolean
link_type
required
string
next_cursor
string
Example
{
  "data": [
    {
      "scope": {
        "level": "tenant"
      }
    }
  ],
  "direction": "out"
}

404

Section titled “404”

No object with that id, or link type unknown.

422

Section titled “422”

Validation error — must supply link_type or role.