Read Guest conversation

GET

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

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

Read an existing instance.

Per-guest cross-channel conversation container. Two-level model per the 2026 vendor convergence: this object is the per-guest anchor; per-reservation segmentation is the optional anchor_reservation_ref plus the temporal guest_conversation_anchored_to_reservation link. Channel lives on guest_message, not here. Lifecycle state tracks the outermost outcome so operator UIs route on it; opt-out scope is the in-thread TCPA / WhatsApp / GDPR signal accumulator that the outbound-action validators honour.

Authorizations

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

properties

required

object

anchor_reservation_ref

Optional reservation anchor (pre-arrival / in-house / departing)

string format: uuid

escalation_count

Count of triages that escalated (denormalised; §B.1)

integer

required

Conversation id

string

inbound_count

Count of inbound messages (denormalised; §B.1)

integer

language

BCP-47 tag of the guest's most recently detected reply language

string

last_message_at

required

Most recent message timestamp (denormalised, §B.1)

string format: date-time

last_message_at_computed_at

Refresh-discipline pair for `last_message_at`

string format: date-time

message_count

Count of messages in this conversation (denormalised; §B.1)

integer

message_count_computed_at

Refresh pair for the four counters (§B.1 discipline)

string format: date-time

opened_at

required

When the conversation opened (first message timestamp)

string format: date-time

opt_out_scope

required

Opt-out signals received in-thread (TCPA / WhatsApp / GDPR)

Array<string>

Allowed values: sms_marketing sms_all whatsapp_marketing email_marketing voice_all gdpr_erasure_requested

person_ref

The guest (person) this conversation belongs to

string format: uuid

redactions_applied

required

Aggregated redaction-kind set across the conversation

Array<string>

Allowed values: pan cvv government_id health_disclosure child_safeguarding other_pii

sentiment_trajectory

Rolling sentiment scores [-1.0, 1.0] per message (bounded length)

Array<string>

state

required

Lifecycle state

string

Allowed values: open awaiting_guest awaiting_staff closed_resolved closed_unresolved escalated

state_reason

Optional short reason on terminal state transitions

string

triage_count

Count of triages issued in this conversation (denormalised; §B.1)

integer

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.guest_conversation",
  "properties": {
    "opt_out_scope": [
      "sms_marketing"
    ],
    "redactions_applied": [
      "pan"
    ],
    "state": "open"
  },
  "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).