Skip to content
aerandil.com
GitHub

Read Group request

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

Read an existing instance.

The inquiry stage for a group block — corporate booking, wedding, conference, sports team. Carries estimated F&B / spa / other ancillary revenue so displacement analysis can run against realistic assumptions, not just room nights. Multi-property blocks (a wedding booking rooms across two properties) hang off the same group_request via the M:N group_request_for_property link.

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.group_request
properties
required
object
description
Notes
string
estimated_fb_revenue
Group request estimated fb revenue

Estimated F&B revenue

object
amount
required
string format: decimal
currency
required
string format: iso-4217
estimated_other_revenue
Group request estimated other revenue

Estimated other ancillary revenue

object
amount
required
string format: decimal
currency
required
string format: iso-4217
estimated_spa_revenue
Group request estimated spa revenue

Estimated spa revenue

object
amount
required
string format: decimal
currency
required
string format: iso-4217
group_kind
required
Group kind
string
Allowed values: corporate wedding conference social government sports tour other
group_size
required
Estimated attendees
integer
id
required
Group request id
string
inquired_at
required
When the inquiry was received
string format: date-time
requested_arrival
required
Requested arrival
string format: date
requested_departure
required
Requested departure
string format: date
room_block_size
required
Room block size
integer
status
required
Funnel status
string
Allowed values: inquiry tentative confirmed lost cancelled
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.group_request",
  "properties": {
    "group_kind": "corporate",
    "status": "inquiry"
  },
  "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).