Read Connector

GET

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

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

Read an existing instance.

The registered instance of one external source-system feed into the ontology (a property’s PMS, POS back-end, rostering tool). Identity + lifecycle only: credentials live in the secret store (secret_ref is a name, never a value), sync cursors live in the raw staging schema, and the mapping definitions are versioned repo files (mapping_refs, one name@version per vendor stream). Lifecycle mutations (pause / resume / retire / start sync) are Actions, so the who-and-when is in the immutable events audit trail.

Authorizations

aerandil_oauth
objects:read
aerandil_oauth
objects:hospitality.connector: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.connector

properties

required

object

cut_over_at

When the house cut over from this source (absent while shadowing)

string format: date-time

cut_over_by

Principal::stable_id() of who took the cutover decision

string

cut_over_summary

The shadow comparison the cutover was taken on (counts, channel connections activated)

display_name

required

Human-readable name shown in the Explorer

string

required

Connector id

string

mapping_refs

required

Mapping definition references (name@version per vendor stream, versioned repo files)

Array<string>

notes

Free-form operator notes

string

paused_reason

Why the connector is paused (required while status = paused)

string

provider

required

Vendor identifier (mews / apaleo / ohip / …)

string

registered_at

required

When the connector was registered

string format: date-time

registered_by

required

Principal::stable_id() of the registering principal

string

schedule

Intended sync cadence, cron form (informational; the worker owns scheduling)

string

secret_ref

Name of the credential in the external secret store (never the value)

string

source_kind

required

Category of source system

string

Allowed values: pms pos rostering inventory accounting distribution other

status

required

Connector lifecycle status

string

Allowed values: active paused retired

vendor_config

Non-secret vendor settings (base URL, site codes, streams)

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.connector",
  "properties": {
    "source_kind": "pms",
    "status": "active"
  },
  "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).