Skip to content
aerandil.com
GitHub

Read Loyalty program

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

Read an existing instance.

A loyalty program — chain-points (Marriott Bonvoy), consortium-soft (LHW Leaders Club), membership-club (Soho House — defers to proposal 0005), or recognition-only (Aman Inner Circle). The four-archetype program_type is labelling over more granular axes (qualification cycle, expiry, redemption, has_points_subsystem, is_published_to_member); the schema admits configurations between archetypes — Preferred I Prefer = consortium_soft + has_points_subsystem; SLH-Hilton = consortium_soft AND chain_points. Recognition is always-on across all archetypes — the program_type does not gate it.

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.loyalty_program
properties
required
object
allowed_channels
Allowed booking channels (SLH-Hilton-style allow-list)
Array<string>
co_brand_card_partners
Co-brand card partners (free-text until points_partner ships)
Array<string>
code
required
Program code
string
effective_from
required
Effective from
string format: date-time
effective_to
Effective to (null when current)
string format: date-time
expiry_rule
required
Expiry rule
string
Allowed values: inactivity_months hard_expiry_months none
expiry_value_months
Expiry threshold (months; required when expiry_rule != none)
integer
family_pooling_policy
Loyalty program family pooling policy

Family pooling policy (gated)

object
allowed
required
boolean
fee_per_pool
object
amount
required
string format: decimal
currency
required
string format: iso-4217
max_members
integer
tier_gated_to
Array<string>
has_points_subsystem
required
Carries a points-liability subsystem
boolean
id
required
Program id
string
lifetime_status_enabled
required
Lifetime tiers offered (Marriott Lifetime Platinum etc.)
boolean
name
required
Program name
string
program_type
required
Program type (labelling)
string
Allowed values: chain_points consortium_soft membership_club recognition_only
redemption_blackout_policy
Redemption blackout policy (gated)
string
Allowed values: none capacity_controlled restricted_dates
tier_qualification_policy
required
Loyalty program tier qualification policy

Tier qualification policy

object
is_published_to_member
required
boolean
kind
required
string
Allowed values: annual_nights_or_spend annual_points lifetime_points dues_continuity discretionary invitation_only observed_frequency
rollover_policy
required
string
Allowed values: none rollover_credits rollover_points
thresholds
required
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.loyalty_program",
  "properties": {
    "expiry_rule": "inactivity_months",
    "program_type": "chain_points",
    "redemption_blackout_policy": "none",
    "tier_qualification_policy": {
      "kind": "annual_nights_or_spend",
      "rollover_policy": "none"
    }
  },
  "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).