List links of Property

GET

/v1/object-types/hospitality.property/objects/{id}/links/{link_type}

const url = 'https://api.aerandil.com/v1/object-types/hospitality.property/objects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/links/hospitality.link.block_for_property?direction=out';
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.property/objects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/links/hospitality.link.block_for_property?direction=out' \
  --header 'Authorization: Bearer <token>'

List the neighbours of an instance along a typed link. Direction is inferred when the source binds the link on exactly one side; symmetric links (same object type on both ends) require an explicit ?direction=out or ?direction=in.

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

aerandil_oauth
objects:read
aerandil_oauth
objects:hospitality.property:read

Parameters

Path Parameters

required

string format: uuid

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

link_type

required

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

API name of the link type. Narrowed to link types that bind this source object type on at least one side.

Query Parameters

direction

Allowed values: out in

Edge direction to follow. Optional when the link binds the source on exactly one side; required for symmetric links.

limit

integer

>= 1 <= 500

cursor

string

as_of

string format: date-time

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

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

Neighbours along the typed link.

application/json

object

data

required

Array<object>

object

created_at

required

string format: date-time

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

No object with that id, or link type unknown.

422

Validation error — direction conflicts with the link’s binding.