Read Reciprocity agreement

GET

/v1/object-types/hospitality.reciprocity_agreement/objects/{id}

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

Read an existing instance.

The org-to-org primitive. Yacht-club reciprocity, Soho House Every House, partner-tier drop-ins, LHW Leaders Club at SLH-Hilton-partnership properties. Distinct from membership_tier because the agreement is between organisations (with cost structure and access scope) and individual member access flows through the agreement, not through a duplicated tier on the partner organisation’s side.

Authorizations

aerandil_oauth
objects:read
aerandil_oauth
objects:hospitality.reciprocity_agreement:read

Parameters

Path Parameters

required

string format: uuid

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

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

200

Object found.

application/json

object

created_at

required

string format: date-time

required

string format: uuid

object_type

required

Allowed value: hospitality.reciprocity_agreement

properties

required

object

access_scope

required

Access scope (full / shared / drop-in / network)

string

Allowed values: full_access shared_with_restrictions drop_in_only network_member

agreement_kind

required

Agreement kind (bilateral / unilateral / network)

string

Allowed values: bilateral unilateral_inbound unilateral_outbound network_membership

agreement_terms_text

Agreement-terms snapshot at signing (design-spec §B.2)

string

code

required

Agreement code

string

cost_structure

required

Cost structure (who pays and how)

string

Allowed values: free member_pays_drop_in member_pays_full host_pays_per_visit reciprocal_credits

description

Description

string

effective_from

required

Effective from

string format: date

effective_to

Effective to (null when ongoing)

string format: date

is_active

required

Currently active

boolean

monthly_visit_cap

Monthly visit cap (capped reciprocity)

integer

name

required

Agreement name

string

per_visit_fee_amount

Reciprocity agreement per visit fee amount

Per-visit fee (required when cost_structure ∈ {member_pays_drop_in, host_pays_per_visit})

object

amount

required

string format: decimal

currency

required

string format: iso-4217

per_visit_fee_currency

Per-visit fee currency (ISO 4217)

string format: iso-4217

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.reciprocity_agreement",
  "properties": {
    "access_scope": "full_access",
    "agreement_kind": "bilateral",
    "cost_structure": "free"
  },
  "scope": {
    "level": "tenant"
  }
}

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

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