Skip to content
aerandil.com
GitHub

Search Connector

POST
/v1/object-types/hospitality.connector/search
curl --request POST \
  --url https://api.aerandil.com/v1/object-types/hospitality.connector/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "cursor": "example", "filters": [ { "property": "id", "type": "eq", "value": "example" } ], "limit": 1, "order": "asc", "property_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "scope": { "level": "tenant" }, "sort_by": "created_at" }'

Search for instances. Filters eq, contains, gte and lte AND-compose; or / not are additive follow-ups. Pages with an opaque cursor; the +1 fetch returns has_more without a second round-trip. Ordered by sort_by (default created_at) in order (default ascending), id breaking ties; rows with no value for a property key sort last.

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

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
branch

Optional open-branch id. Search composes that branch’s copy-on-first-write overlay instead of main, so a preview reads its own hypothetical writes. Omit to read main.

string format: uuid
cursor

Opaque cursor from a prior response’s next_cursor. Pass back verbatim; do not introspect.

string
filters

Conjunctive list of predicates. Empty or omitted matches every row in scope, capped by limit.

Array
One of:
object
property
required
Allowed value: id
type
required
Allowed value: eq
value
required
string
limit

Page size. Server defaults to 50, silently clamps at 500 (AIP-158 §3).

integer
>= 1 <= 500
order

Direction of sort_by: asc (oldest / smallest first) or desc. A cursor is bound to the sort_by and order it was minted under; another pair is refused (422).

string
default: asc
Allowed values: asc desc
property_id

The house a desk stands in: keeps this property’s rows (property- or venue-scoped there) and every row scoped to no property (tenant, brand, portfolio), and drops a sibling house’s — the meaning property_id has on the event tail.

string format: uuid
scope
One of: discriminator: level
object
level
required
string
Allowed value: tenant
Allowed values: tenant
sort_by

What the page is ordered by: the row’s created_at or updated_at, or a property whose type orders — strings, enums and dates as text, ints, decimals and durations as numbers, datetimes as instants. Rows with no value sort last in either direction. A property the caller is not cleared to read is refused (403).

string
default: created_at
Allowed values: created_at updated_at id display_name source_kind provider status secret_ref schedule registered_by registered_at paused_reason notes cut_over_at cut_over_by

Responses

Section titled “Responses”

200

Section titled “200”

Search results, ordered by (sort_by, id) in the requested order (ascending by default).

Media typeapplication/json
object
data
required
Array<object>
object
created_at
required
string format: date-time
id
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
id
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
has_more
required
boolean
next_cursor

Cursor for the next page; omitted when the result set is exhausted.

string
Example
{
  "data": [
    {
      "object_type": "hospitality.connector",
      "properties": {
        "source_kind": "pms",
        "status": "active"
      },
      "scope": {
        "level": "tenant"
      }
    }
  ]
}

422

Section titled “422”

Validation error — unknown property or filter type mismatch.